June 2, 1997 SEDSIZE - Version: 1.9 1997/06/02 SIZEDATA - Version: 1.10 1997/06/02 Particle-size statistics of fluvial sediments For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the files doc/sedsize.txt and sizedata.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: sedsize1.9.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4 sedsize1.9.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5 sedsize1.9.source.tar.gz - Source code B. EXTRACTING FILES The compressed tar file, named sedsize1.9.OS.tar.gz, contains all the files needed to install and test SEDSIZE 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 sedsize1.9.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 sedsize1.9 is created (or overwritten) when the files are extracted from the tar file. If the sedsize1.9 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 sedsize1.9.____.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 sedsize1.9.____.tar.gz 4. Extract the distribution files from the tar file. For example: tar -xof sedsize1.9.___.tar This creates the following directory structure (the contents of each directory are shown to the right): sedsize1.9 ; 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 sedsize1.9.source.tar.gz distribution (it is created during compilation). b) Source code is included only with the sedsize1.9.source.tar.gz distribution. c) It is recommended that no user files be kept in the sedsize1.9 directory structure. If you do plan to put files in the sedsize1.9 directory structure, do so only by creating subdirectories of sedsize1.9. 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 sedsize1.9.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 sedsize1.9/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 sedsize1.9/bin and BINDIR if they do not already exist, b. compile the source code, c. place the executables (sedsize and sizedata) in sedsize1.9/bin, and d. place links to the executables in BINDIR if specified. D. INSTALLING To make the executables (sedsize and sizedata) 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 sedsize1.9/src) contains instructions to optionally place links in a specified directory to the executables contained in sedsize1.9/bin. Use the following two commands to do this: cd sedsize1.9/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 SEDSIZE executable files, the installer must have sufficient rights in the directory that BINDIR is set to. E. RUNNING THE SOFTWARE After SEDSIZE is properly installed in a directory that is included in your PATH, the program is initiated using the command: sedsize. SEDSIZE prompts for the input file name (default name=size.dat) and then for the output file name (default name based on input file name). The input file is a direct access file that must be created using the sizedata program. SIZEDATA 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 sedsize1.9/test contains the scripts to run the tests. The directory sedsize1.9/data contains the input data and expected results for each test. Tests are usually run in the directory sedsize1.9/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 sedsize1.9/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/sedsize1.9/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=2 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 sedsize Bed material samples from Columbia River at Vancouver, Wash.; bed material samples from Columbia River at Beaver Army Terminal, Oreg.; bed material samples from Columbia River Estuary; and bed material from flume during mixture run SEDSIZE input data sedsize1.dat i Program output sedsize1.out o 2 sedsize Data set 4 and Data set 5 SEDSIZE input data sedsize2.dat i Program output sedsize2.out o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *