October 9, 1997 MODFLOWP Parameter-Estimation Version of the Modular Model MODFLOWP - Version: 3.2 1997/10/09 RESANP - Version: 3.2 1997/07/24 BCINT - Version: 3.1 1997/07/24 YCINT - Version: 3.1 1997/07/24 BEALEP - Version: 3.1 1997/07/24 For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc/Modflowp.txt for descriptions, references, and additional contacts for this software. Instructions for installation, execution, and testing are provided below. TABLE OF CONTENTS A. FILES B. EXTRACTING FILES C. COMPILING D. INSTALLING E. RUNNING THE SOFTWARE F. TESTING A. FILES The following distribution packages (containing the software, test data sets, and information files) are currently available for UNIX systems: Modflwp3.2.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4 Modflwp3.2.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5 Modflwp3.2.source.tar.gz - Source code For use on Data General workstations, the program source code consists of the following files (found in the Modflwp3.2/src directory): adv1.f chd1.f hfb1.f rch5.f sor5.f util.f bas5p.f de45p.f ibs1.f res1.f spar.f utl5.f bcf1.f drn5p.f modflowp.f resanp.f ssen-ai.f wel5.f bcf5p.f evt5p.f obs.f riv5p.f ssen-jz.f ycint.f bcint.f gfd1.f par.f sen.f str5p.f bealep.f ghb5p.f pcg2.f sip5.f tlk1.f Makefile -- input instructions to the UNIX "make" utility for compiling MODFLOWP B. EXTRACTING FILES The compressed tar file, named Modflwp3.2.OS.tar.gz, contains all the files needed to install and test MODFLOWP on a computer with a particular operating system, where OS is a string indicating the operating system the distribution is intended for. If a version is not available for your operating system, the file Modflwp3.2.source.tar.gz contains the source code and all other files needed to compile, install, and test the software on a UNIX-based computer. For either type of distribution, the directory Modflwp3.2 is created (or overwritten) when the files are extracted from the tar file. If the Modflwp3.2 directory already exists, you may want to delete or rename it before extracting the files. The following are the steps to extract the files from a distribution tar file. 1. If the tar file is not already in the directory under which you want the distribution installed, move it there. For example: mv Modflwp3.2.____.tar.gz /usr/opt/wrdapp 2. If you are not in the directory where the tar file is located, go there. For example: cd /usr/opt/wrdapp 3. Uncompress the distribution file. For example: gunzip Modflwp3.2.____.tar.gz 4. Extract the distribution files from the tar file. For example: tar -xpof Modflwp3.2.___.tar This creates the following directory structure (the contents of each directory are shown to the right): Modflwp3.2 ; copy of this README file `-----bin ; compiled executables `-----doc ; documentation files `-----src ; Makefile and source code `-----test ; scripts to run verification tests `-----data ; standard data sets used in verification tests Notes: a) The bin directory is not included in the Modflwp3.2.source.tar.gz distribution (it is created during compilation). b) Source code is included only with the Modflwp3.2.source.tar.gz distribution. c) It is recommended that no user files be kept in the Modflwp3.2 directory structure. If you do plan to put files in the Modflwp3.2 directory structure, do so only by creating subdirectories of Modflwp3.2. C. COMPILING If a compiled version of the software is not available for your computer, or if you want to build the executables yourself, follow the instructions in this section. If you have retrieved a pre-compiled distribution of the software, skip to the Installing section below. The source code is provided in the Modflwp3.2.source.tar.gz distribution so that users can generate the executables themselves. No support can be provided for users generating their own versions of the software. In general, the requirements are a Fortran compiler and a minimal level of knowledge of the compiler and the UNIX operating system. As provided, the Makefile and source code are set up for use on Data General AViiON workstations running the DG/UX operating system. To generate new executables, do the following: 1. Change directory to the source directory: cd Modflwp3.2/src 2. Modify the beginning of the file named Makefile to correctly specify system-dependent variables: F77 Fortran compiler name FFLAGS Fortran compiler flags 3. Use the make program to initiate compilation of the source code and installation of the software: make [BINDIR=directory_for_links] See the Installing instructions below for an explanation of BINDIR. The make will: a. create the directories Modflwp3.2/bin and BINDIR if they do not already exist, b. compile the source code, c. place the executables (Modflowp, resanp, bealep, ycint, and bcint) in Modflwp3.2/bin, and d. place links to the executables in BINDIR if specified. D. INSTALLING To make the executables (Modflowp, resanp, bealep, ycint, and bcint) easy to use, they should be installed in a directory included in the user's search path. The Makefile (input instructions to the UNIX make program--located in Modflwp3.2/src) contains instructions to optionally place links in a specified directory to the executables contained in Modflwp3.2/bin. Use the following two commands to do this: cd Modflwp3.2/src make install [BINDIR=directory_for_links] If BINDIR is specified, links to the executables are placed in the specified directory. For example, if your search path consists of: /usr/bin:/usr/opt/bin:/usr/local/bin use the command: make install BINDIR=/usr/local/bin to make the executables accessible from any directory without requiring the full pathname of the software's location. Notes: a) Brackets "[xxx]" are used to indicate optional arguments to commands. b) To create and delete links to the MODFLOWP executable files, the installer must have sufficient rights in the directory that BINDIR is set to. E. RUNNING THE SOFTWARE The X array is dimensioned to 5,000,000. This is large enough for a model having approximately 250,000 cells. After MODFLOWP is properly installed in a directory that is included in your PATH, the program is initiated using the command: Modflowp. MODFLOWP prompts the user to enter the name of the Name File, and then it automatically opens all the files specified in the Name File. Each record of the Name File specifies a file type, unit number, and file name for each file used in the MODFLOWP simulation. In addition to defining the file names and unit numbers, the Name File activates packages. That is, the IUNIT elements that correspond to the packages indicated by the file types are turned "on". The IUNIT record in the BAS Package input file is ignored; packages can now only be activated through the Name File. The Name File is read on unit 99, so this unit should not be used for any other model files. Refer to the MODFLOW-96 documentation (USGS Open-File Report 96-485) for details about preparing the Name File. An example of a Name File follows: list 4 tc2.lsp bas 5 ../data/tc2.bas par 16 ../data/tc2.par data 10 ../data/tc2.bnd data 12 ../data/tc2.shd oc 11 ../data/tc2.out bcf 7 ../data/tc2.bcf riv 15 ../data/tc2.riv rch 31 ../data/tc2.rch wel 8 ../data/tc2.wel pcg 9 ../data/tc2.pcg data 13 tc2.b data 35 tc2.res F. TESTING Test data sets are provided to verify that the program is correctly installed and running on the system. The tests may also be looked at as examples of how to use the program. The directory "Modflwp3.2/test" contains the scripts to run the tests. The directory "Modflwp3.2/data" contains the input data and expected results for each test. Tests must be run in the directory "Modflwp3.2/test". Run the tests using any of the commands in the table below. To test the installation, change to the Modflwp3.2/test directory and type the command: ./test.sh [m [n]] where: m = the number of the first test to perform, default=1 n = the number of the last test to perform, default=12 For example: command what happens ------------------ ------------------------------------ ./test.sh runs all of the tests ./test.sh n runs test 'n' thru the last test ./test.sh n m runs test 'n' thru 'm' After the tests are completed, the results are compared to the expected results. If all goes well, the only differences will be due to different processing times or pathnames. To clean up after the tests, type the command: ./clean.sh NOTE: the standard data sets were created on a Data General AViiON workstation. You may notice slight numeric differences in the results on other computers. These are generally due to different round-off algorithms and the different architecture of the central processing unit chip. The tests are described in the table below. Test is the test number, program is the program used to run the test, and the usage column indicates how a file is used, with i for input, o for output, and i/o for both input and output. test program description of test and files file name & usage ---- ------- --------------------------------- ----------------- 1 Modflowp TEST CASE 1, TWO-LAYER EXAMPLE Steady State Name File to designate files tc1ss.fil i MODFLOW basic data tc1ss.bas i Block-Centered Flow data tc1ss.bcf i Streams Package data tc1ss.str i General-Head Boundary data tc1ss.ghb i Recharge Package data tc1ss.rch i Preconditioned Conjugate-Gradient tc1.pcg i Output control data tc1ss.out i BCF data array tc1file.18 i recharge array tc1arr.rch i Program results tc1ss.lsp o head data results tc1ss.hds o 2 Modflowp TEST CASE 1, TWO-LAYER EXAMPLE Transient Name File to designate files tc1tr.fil i MODFLOW basic data tc1tr.bas i Block-Centered Flow data tc1tr.bcf i Well data tc1tr.wel i Streams Package data tc1tr.str i General-Head Boundary data tc1tr.ghb i Recharge Package data tc1tr.rch i recharge array tc1arr.rch i Preconditioned Conjugate-Gradient tc1.pcg i Output control data tc1tr.out i Steady-state head data tc1tr.hds i BCF data array tc1file.18 i Program results tc1tr.lsp o 3 Modflowp TEST CASE 1, TWO-LAYER EXAMPLE Parameter Estimation Name File to designate files tc1.fil i MODFLOW basic data tc1.bas i parameter data tc1.par i Output control data tc1.out i Block-Centered Flow data tc1.bcf i Recharge Package data tc1.rch i recharge array tc1arr.rch i Well data tc1.wel i General-Head Boundary data tc1.ghb i Streams Package data tc1.str i DE45 Package data tc1.de4 i Program results tc1.lsp o Restart data tc1.res o head data results tc1.b o 4 Modflowp TEST CASE 2, ONE-LAYER EXAMPLE Steady state, without parameter estimation Name File to designate files tc2ss.fil i MODFLOW basic data tc2ss.bas i Boundary condition data (file 10) tc2.bnd i File 12 for basic input data tc2.shd i Output control data tc2.out i Block-Centered Flow data tc2.bcf i River Package data tc2.riv i Recharge Package data tc2.rch i Well data tc2.wel i Preconditioned Conjugate-Gradient tc2.pcg i Program results tc2ss.lsp o 5 Modflowp TEST CASE 2, ONE-LAYER EXAMPLE with parameter estimation Name File to designate files tc2.fil i MODFLOW basic data tc2.bas i parameter data tc2.par i Boundary condition data (file 10) tc2.bnd i File 12 for basic input data tc2.shd i Output control data tc2.out i Block-Centered Flow data tc2.bcf i River Package data tc2.riv i Recharge Package data tc2.rch i Well data tc2.wel i Preconditioned Conjugate-Gradient tc2.pcg i Program results tc2.lsp o head data results tc2.b o Restart data tc2.res o 6 Modflowp Runs the storage depletion test problem in OFR 88-482 Name File to designate files ibs.fil i BAS5 Package ibs.bas i BCF5 Package ibs.bcf i SIP5 Package ibs.sip i Output Control ibs.oc i IBS1 Package ibs.ibs i Listing of results ibs.lst o 7 Modflowp Runs the example problem in OFR 88-729 Name File to designate files str.fil i BAS5 Package str.bas i BCF5 Package str.bcf i SIP5 Package str.sip i Output Control str.oc i STR1 Package str.str i Listing of results str.lst o 8 Modflowp Runs the problem in Appendix D of TWRI 6-A1 Name File to designate files twri.fil i BAS5 Package twri.bas i BCF5 Package twri.bcf i WEL1 Package twri.wel i DRN5 Package twri.drn i RCH5 Package twri.rch i SIP5 Package twri.sip i Listing of results twri.lst o 9 Modflowp Runs problem 1 in OFR 91-536 Name File to designate files bcf2ss.fil i BAS5 Package bcf2ss.bas i BCF5 Package bcf2ss.bcf i WEL1 Package bcf2ss.wel i RIV5 Package bcf2ss.riv i RCH5 Package bcf2ss.rch i PCG2 Package bcf2ss.pcg i Output Control bcf2ss.oc i listing of results bcf2ss.lst o 10 Modflowp Runs the first problem in OFR 94-59 Name File to designate files tlkp1.fil i BAS5 Package tlkp1.bas i BCF5 Package tlkp1.bcf i TLK1 Package tlkp1.tlk i SIP5 Package tlkp1.sip i Output Control tlkp1.oc i Listing of results tlkp1.lst o cell-by-cell flows, storage tlkp1.bud o drawdown and heads results tlkp1.ddn o 11 Modflowp Runs the example problem in OFR 96-364 Name File to designate files restest.fil i BAS5 Package restest.bas i BCF5 Package restest.bcf i GHB5 Package restest.ghb i SIP5 Package restest.sip i Output Control restest.oc i RES1 (Reservoir) Package restest.res i Listing of results restest.lst o 12 Modflowp Runs the Otis Air Force Base Test Problem 2 Name File to designate files adv1.fil i ADV1 Package adv1.adv i BAS5 Package adv1.bas i BCF5 Package adv1.bcf i GHB5 Package adv1.ghb i Output Control adv1.oc i parameter data adv1.par i PCG2 Package adv1.pcg i RCH5 Package adv1.rch i RIV5 Package adv1.riv i File 12 for basic input data adv1.shd i THK data adv1.thk i bottom data adv1.bot i top data adv1.top i WEL5 Package adv1.wel i head data results adv1.b o Listing of results adv1.lsp o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *