README.TXT - Windows

GoPhast: Version 1.0.9.0, May 13, 2008
A Graphical User Interface for PHAST

NOTE: Any use of trade, product or firm names is for descriptive purposes 
only and does not imply endorsement by the U.S. Government.

This version of MODFLOW-2000 is packaged for personal computers using
Microsoft Windows 2000, or XP.

A. DISTRIBUTION FILE

The following installer is for use on personal computers:

         SetupGoPhast1_0_9.exe

The distribution file contains:

          Compiled runfiles and source code for GoPhast, WebIndexer, 
             HelpGenerator and the GoPhast testing tool.
          User documentation.
          Programmer's Guide
          Data files used to reproduce the examples in the User 
             documentation.
          Sample files for GoPhast.
          Project file for Help Generator to recreate the goPhast 
             Programmer's Guide from the source code.
          Images used in the Programmer's Guide.
          Project file for WebIndexer to create the search index
             for the GoPhast help.
          Project file for the GoPhast testing tool to run tests 
             on GoPhast.
          Comparison files for use in the GoPhast testing tool.


B. EXTRACTING FILES

The distribution file is an installer.  Execution of the
distribution file creates numerous individual files.  The extraction
program allows you to specify the base directory into which the files 
will be placed.  The installation instructions assume that the files 
are restored into directory C:\Program Files\USGS\GoPhast.  The 
following directory structure will be created in 
C:\Program Files\USGS\GoPhast:


   |
   |--bin             ; compiled executables, required dll's and project 
   |    |               files for WebIndexer, HelpGenerator and the 
   |    |               GoPhast testing tool.
   |    |     
   |    help          ; base directory for GoPhast context sensitive help
   |       |--files   ; main directory for GoPhast context sensitive help
   |--data            ; files used in recreating the examples
   |--doc             ; documentation files
   |--guide           ; image files for Programmer's Guide and output 
   |                    directory for Help Generator when used to create
   |                    the Programmer's Guide.
   |                   
   |--samples         ; sample GoPhast files
   |--src             ; source code
   |    |     
   |    |--Components         ; source code for components used in GoPhast,  
   |    |                       WebIndexer,HelpGenerator and the GoPhast 
   |    |                        testing tool.
   |    |   
   |    |--GoPhast            ; GoPhast source code
   |    |--GoPhastTestingTool ; GoPhast Testing Tool source code
   |    |--HelpGenerator      ; Help Generator source code
   |    |--WebIndexer         ; Web Indexer source code


It is recommended that no user files are kept in the GoPhast directory
structure.  If you do plan to put files in the GoPhast directory
structure, do so only by creating subdirectories.

Included in directory GoPhast\doc are various documentation files.  Some
of them are Portable Document Format (PDF) files. The PDF files are readable
and printable on various computer platforms using Acrobat Reader from Adobe.
The Acrobat Reader is freely available from the following World Wide Web
sites:
      http://www.adobe.com/
      http://www.shareware.com/


C. COMPILING

Although executable versions of the programs are provided, the source
code is provided in the GoPhast\src directory so that the programs can
be recompiled if necessary.  The programs were compiled with Borland
Delphi version 7. No support can be provided for users generating their 
own versions of the software. 

In general, to install GoPhast, the components in the src\Components
directory must first be installed in Borland Delphi 7.  In addition the 
JEDI Code Library  must be installed (http://sourceforge.net/projects/jcl/)  
Then the project file for GoPhast can be opened and compiled.

D. INSTALLING

To install GoPhast, run the installer and respond to the prompts
as appropriate.  Two different installation options are available.
1. GoPhast program, help, documentation, and examples.
2. GoPhast program, help, documentation, examples, source code, and 
Programmer's guide.

Only the second option includes Web Indexer, Help Generator and the 
GoPhast testing tool.

The first option is appropriate for most users.

E. RUNNING THE SOFTWARE

GoPhast, Web Indexer, Help Generator and the GoPhast testing tool may
be run by clicking on the icon created by the installer, double-clicking on 
an associated project file (except Web Indexer), or double-clicking on the
executable. 

F. TESTING

The GoPhast testing tool may be used to verify that GoPhast is operating
correctly.  To use it, start TestGoPhast.exe and open GoPhastTest.txt with 
it.  Then select "File|Run Test."  The GoPhast testing tool will report 
the results of the tests in a dialog box when the tests are complete.