January 16, 1998
MODEIN - Version 1.4 1998/01/16
MEPDATA - Version 1.3 1998/01/16
Computation of total sediment discharge
by the modified Einstein procedure
For assistance, enhancement requests, or bug reports contact the Hydrologic
Analysis Software Support Team via email at h2osoft@usgs.gov. See the file
doc/modein.txt for descriptions, references, and additional contacts for
this software. Instructions for installation, execution, and testing are
provided below.
TABLE OF CONTENTS
A. DISTRIBUTION PACKAGES
B. EXTRACTING FILES
C. COMPILING
D. INSTALLING
E. RUNNING THE SOFTWARE
F. TESTING
A. DISTRIBUTION PACKAGES
MODEIN is distributed as a package that contains the computation program
(modein) software, the input data processor program (mepdata), data sets,
and information files. The software is available either uncompiled
(source code), or compiled for one of two operating systems (contains the
executable files, but not the source code). The following distribution
packages are currently available for UNIX systems:
modein_1.4.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4
modein_1.4.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5
modein_1.4.source.tar.gz - Source code
B. EXTRACTING FILES
The compressed tar file, named modein_1.4.OS.tar.gz, contains all the files
needed to install and test MODEIN on a computer with a particular operating
system, where OS is a string indicating the operating system the distribution
is intended for. For either type of distribution, the directory modein_1.4 is
created (or overwritten) when the files are extracted from the tar file. If
the modein_1.4 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 modein_1.4.____.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 modein_1.4.____.tar.gz
4. Extract the distribution files from the tar file. For example:
tar -xpof modein_1.4.___.tar
This creates the following directory structure (the contents of each
directory are shown to the right):
modein_1.4 ; copy of this README file
`-----bin ; compiled executable
`-----doc ; documentation files
`-----src ; Makefile
`-----test ; scripts to run verification tests
`-----data ; standard data sets used in verification tests
Notes:
a) The bin directory is not included in the modein_1.4.source.tar.gz
distribution (it is created during compilation).
b) Source code is included only with the modein_1.4.source.tar.gz
distribution.
c) It is recommended that no user files are kept in the modein_1.4 directory
structure. If you do plan to put files in the modein_1.4 directory
structure, do so only by creating subdirectories of modein_1.4.
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 modein_1.4.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 modein_1.4/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 modein_1.4/bin and BINDIR if they do not
already exist,
b. compile the source code,
c. place the executables (modein and mepdata) in modein_1.4/bin, and
d. place links to the executables in BINDIR if specified.
D. INSTALLING
To make the executables (modein and mepdata) 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 modein_1.4/src)
contains instructions to optionally place a link in a specified directory to
the executables contained in modein_1.4/bin. Use the following two commands
to do this:
cd modein_1.4/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 MODEIN executable file, the installer must
have sufficient rights in the directory that BINDIR is set to.
E. RUNNING THE SOFTWARE
After MODEIN is properly installed in a directory that is included in your
PATH, the program is initiated using the command: modein. MODEIN prompts
for the input data file name (default name=MEPDATA.INP) and then for the
output file name. The input data file is a direct-access file that must be
created using the mopdata program. MEPDATA prompts in a conversational
fashion for all required data.
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 "modein_1.4/test" contains the scripts to
run the tests. The directory "modein_1.4/data" contains the input data and
expected results for each test. Tests are usually run in the directory
"modein_1.4/test", but they can be run in any user directory if the
installation procedure was completed (make install performed). Run the tests
using any of the commands in the table below. To test the installation,
change to the modein_1.4/test directory and type the command:
./test.sh [m [n]]
If running from another directory, specify the full path to the script; for
example:
/usr/opt/wrdapp/modein_1.4/test/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=4
For example:
command what happens
------------------ ------------------------------------
./test.sh runs all of the tests
./test.sh n runs test 'n' through the last test
./test.sh n m runs test 'n' through '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 modein Rio Grande at San Acacia, NM
mepdata
MEPDATA input data mepdata1.dat i
MEPDATA output file mepdata1.out i/o
MODEIN ouptut file modein1.out o
2 modein Feather River near Gridley, CA
mepdata
MEPDATA input data mepdata2.dat i
MEPDATA output file mepdata2.out i/o
MODEIN ouptut file modein2.out o
3 modein Niobrara River near Cody, NE - Sect C2
mepdata
MEPDATA input data mepdata3.dat i
MEPDATA output file mepdata3.out i/o
MODEIN ouptut file modein3.out o
4 modein Rio Grande at San Acacia, NM
mepdata
MEPDATA input data mepdata4.dat i
MEPDATA output file mepdata4.out i/o
MODEIN ouptut file modein4.out o
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Good Luck!
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *