June 2, 1997 WSPRO88 - Version: V060188 1.4 1996/01/17 Water Surface PROfile For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc\wspro88.txt for descriptions, references, and additional contacts for this software. Instructions for installation, execution, and testing are provided below. This version of WSPRO88 is packaged for use on personal computers using the DOS operating system. The installation procedures and the compiled version of WSPRO88 must be run using either DOS directly or a DOS window within Microsoft Windows, Windows 95, or Windows NT. TABLE OF CONTENTS A. FILES B. EXTRACTING FILES C. COMPILING D. INSTALLING E. RUNNING THE SOFTWARE F. TESTING A. FILES The following self-extracting DOS distribution files (containing the software, test data sets, and information files) are currently available. wspro88.exe - Compiled using Lahey Fortran 90 with source code wspro88b.exe - Compiled using Lahey Fortran 90 (binaries only) wspro88s.exe - Source code only B. EXTRACTING FILES For whichever WSPRO88 distribution file that you have acquired, wspro88.exe, wspro88b.exe, or wspro88s.exe, the directory wspro88 is created (or overwritten) when the files are extracted. If the wspro88 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 file. Note, replace with the drive letter where you want to install WSPRO88 and optionally replace [directory] with the name of a directory on that drive: 1. If you are not in the directory where the distribution file is located, go there. For example (if already on the C disk drive): cd c:\wrdapp 2. Extract the files using the command: wspro88 -d -o :\[directory] Substitute "wspro88b" or "wspro88s" for "wspro88" if you are installing the executable-code-only or source-code distributions, respectively. Note, be sure to include the -d (restore directory structure) and -o (overwrite existing files) options and ":\" in the command. Examples are: wspro88 -d -o c:\ wspro88 -d -o c:\wrdapp The following directory structure will be created (the contents of each directory are shown to the right): wspro88 ; copy of this readme file `-----bin ; compiled executable and Lahey error file `-----doc ; documentation files `-----src ; makefile and source code `-----test ; batch files to run verification tests `-----data ; standard data sets used in verification tests Notes: a) The executable is not included in the wspro88s.exe distribution file. b) The source code is not included in the wspro88b.exe distribution file. c) It is recommended that no user files are kept in the wspro88 directory structure. If you do plan to put files in the wspro88 directory structure, do so only by creating subdirectories of wspro88. d) Brackets "[xxx]" are used to indicate optional arguments to commands. C. COMPILING The source code is provided in the wspro88.exe and wspro88s.exe distribution files 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 DOS operating system. As provided, the makefile and source code are optimized for use on a Pentium personal computer using the Lahey Fortran 90 compiler and supplied make program. To generate a new executable, do the following: 1. Change directory to the source directory: cd wspro88\src 2. Modify the beginning of the file named makefile to correctly specify system-dependent variables: FFLAGS Fortran compiler flags FC Fortran compiler name LINKER Fortran linker name LNKFLGS Fortran linker flags OS Name for system-dependent routines 3. Provide a file sys_xx.f, where xx is the string that the system- dependent variable (OS) is set to in the makefile. This file contains system-dependent routines that query the computer for the current date and time. Versions of sys_xx.f are included for Lahey EM/32 and LF90 and MicroSoft Fortran. 4. Use the make program to initiate compilation of the source code and installation of the software: make [BINDIR=directory_for_executable] See the Installing instructions below for an explanation of BINDIR. The make will: a. create the directory wspro88\bin if it does not exist, b. compile the source code, c. place the executable (wspro88.exe) in wspro88\bin, and d. place a copy of the executable in BINDIR if specified. D: INSTALLING To make the WSPRO88 program accessible from any directory, the directory containing the executable should be included in the PATH environment variable. For example, you could add a line similar to the following to the AUTOEXEC.BAT file: PATH=%PATH%;C:\wspro88\bin Note, substitute the appropriate drive letter and pathname if not C:\ as shown above. As an alternative, the WSPRO88 executable can be installed in a directory already included in the PATH environment variable. The makefile (input instructions to the Lahey make program--located in wspro88\src) contains instructions to optionally place a copy of the executable contained in wspro88\bin in a specified directory. Use the following two commands to do this: cd wspro88_source_directory make install BINDIR=directory_for_executable For example: cd C:\wspro88\src make install BINDIR=C:\wrdapp\bin Note, the makefile may need to be modified to be used with make programs other than the Lahey make program. E. RUNNING THE SOFTWARE **System Requirements** - 386-based or higher personal computer with math co-processor running DOS. - 2 MB application RAM - 1 MB disk space WSPRO88 has been compiled using the Lahey Fortran 90 extended memory compiler version 3.00f. The file "LF90.EER" (from the Lahey compiler) located in wspro88\bin contains error messages. If an error occurs, this file is used to print error messages if the wspro88\bin directory is included in the PATH environment variable; if LF90.ERR cannot be found, the error will only be identified by number. After WSPRO88 is properly installed in a directory that is included in your PATH, the program is initiated using the command: wspro88. The program prompts for the input and printed output file names. Data in the input file must be coded according to specifications given in the user's guide. 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 wspro88\test contains batch files to run the tests. The directory wspro88\data contains the input data and expected results for each test. Run the tests in the wspro88\test directory using the command: test After the tests are completed, the results can be compared to the expected results. To clean-up after the tests, type the command: clean 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 wspro88 Transfer known rating to upstream sections input data wspro1.dat i wspro printed output wspro1.prt o 2 wspro88 Initial bridge backwater computations input data wspro2.dat i wspro printed output wspro2.prt o 3 wspro88 Additional bridge backwater computations input data wspro3.dat i wspro printed output wspro3.prt o 4 wspro88 Dry Creek near Barren Hills Simple bridge example input data wspro4.dat i wspro printed output wspro4.prt o 5 wspro88 Steep Creek near Nowhere, USA input data wspro5.dat i wspro printed output wspro5.prt o 6 wspro88 Multiple opening bridge example symmetrical channel with two unidentical bridges input data wspro6.dat i wspro printed output wspro6.prt o 7 wspro88 Some Creek near Anywhere, USA Simple open-channel profile example: constant discharge, subcritical flow input data wspro7.dat i wspro printed output wspro7.prt o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *