June 12, 1997 E431 - Version: 83.180 1.8 1995/11/22 Step-Backwater and Floodway Analyses For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc/e431.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: e431_83.180.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4 e431_83.180.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5 e431_83.180.source.tar.gz - Source code B. EXTRACTING FILES The compressed tar file, named e431_83.180.OS.tar.gz contains all the files needed to install and test E431 on a computer with a particualar 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 e431_83.180.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 e431_83.180 is created (or overwritten) when the files are extracted from the tar file. If the e431_83.180 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 e431_83.180.____.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 e431_83.180.____.tar.gz 4. Extract the distribution files from the tar file. For example: tar -xpof e431_83.180.___.tar This creates the following directory structure (the contents of each directory are shown to the right): e431_83.180 ; copy of this README file `-----bin ; compiled executable `-----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 e431_83.180.source.tar.gz distribution (it is created during compilation). b) Source code is included only with the e431_83.180.source.tar.gz distribution. c) It is recommended that no user files be kept in the e431_83.180 directory structure. If you do plan to put files in the e431_83.180 directory structure, do so only by creating subdirectories of e431_83.180. C. COMPILING If a compiled version of the software is not available for your computer, or if you want to build the executable 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 e431_83.180.source.tar.gz distribution so that users can generate the executable 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 makefiles and source code are set up for use on Data General AViiON workstations running the DG/UX operating system. To generate a new executable, do the following: 1. Change directory to the source directory: cd e431_83.180/src 2. Modify the beginning of the file named Makefile to correctly specify system-dependent variables: F77 Fortran compiler name FFLAGS Fortran compiler flags OS Operating system name 3. Provide a file timdat.xx.f, where xx is the string that the operating system variable (OS) is set to in the Makefile. Versions of timdat.f are included for Data General, Silicon Graphics, and Sun workstations. The timdat.f file contains subroutines that query the computer for the current date and time. 4. 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 e431_83.180/bin and BINDIR if they do not already exist, b. compile the source code, c. place the executable (e431) in e431_83.180/bin, and d. place a link to the executable in BINDIR if specified. D. INSTALLING To make the executable (e431) easy to use, it should be installed in a directory included in the user's search path. The Makefile (input instructions to the UNIX make program--located in e431_83.180/src) contains instructions to optionally place a link in a specified directory to the executable contained in e431_83.180/bin. Use the following two commands to do this: cd e431_83.180/src make install [BINDIR=directory_for_links] If BINDIR is specified, a link to the executable is 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 executable 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 a link to the E431 executable file, the installer must have sufficient rights in the directory that BINDIR is set to. E. RUNNING THE SOFTWARE After E431 is properly installed in a directory that is included in your PATH, the program is initiated using the command: e431. E431 prompts for the input and output file names. Data in the input file must be coded according to specifications given in the User's Manual. 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 e431_83.180/test contains the scripts to run the tests. The directory e431_83.180/data contains the input data and expected results for each test. Tests must be run in the directory e431_83.180/test. Run the tests using any of the commands in the table below. To test the installation, change to the e431_83.180/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=8 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 e431 SIMPLE REACH - E431 USERS MANUAL PP 65-67 input data ex01.dat i computed results ex01.out o 2 e431 SIMPLE REACH/TRIBUTARY - E431 MANUAL PG 68 input data ex02.dat i computed results ex02.out o 3 e431 SIMPLE REACH- RATING - E431 MANUAL PG 69 input data ex03.dat i computed results ex03.out o 4 e431 SIMPLE REACH -- PRE-BRIDGE STUDY -- E431 MANUAL PP 71-73 input data ex04.dat i computed results ex04.out o 5 e431 SIMPLE REACH -- BRIDGE STUDY -- E431 MANUAL PP 71-73 input data ex05.dat i computed results ex05.out o 6 e431 ROAD OVERFLOW PROBLEM ------ E431 USER'S MANUAL input data ex06.dat i computed results ex06.out o 7 e431 ROAD-BRIDGE COMPOSITE ------ E431 USER'S MANUAL input data ex07.dat i computed results ex07.out o 8 e431 SIMPLE FLOODWAY - E431 USERS MANUAL PP 90-91 input data ex08.dat i computed results ex08.out o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *