May 2, 1997 SAC - Version 97-01 1997/05/01 Slope-Area Computation Program For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc/sac.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 The following distribution packages (containing the software, test data sets, and information files) are currently available for UNIX systems: sac97.01.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4 sac97.01.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5 sac97.01.source.tar.gz - Source code Included in directory sac97.01/doc is a Portable Document Format (PDF) version of the SAC documentation (sacman.pdf). A PostScript version of this report is available from: http://water.usgs.gov/software/sac.html The PDF file is readable and printable on various computer platforms using Acrobat Reader from Adobe. The Acrobat Reader is freely available from the following World Wide Web sites: http://www.adobe.com/ http://www.shareware.com/ and by File Transfer Protocol (FTP) from the following site: ftp.adobe.com (path: /pub/adobe/acrobat) B. EXTRACTING FILES The compressed tar file, named sac97.01.OS.tar.gz, contains all the files needed to install and test SAC 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 sac97.01.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 sac97.01 is created (or overwritten) when the files are extracted from the tar file. If the sac97.01 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 sac97.01.____.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 sac97.01.____.tar.gz 4. Extract the distribution files from the tar file. For example: tar -xpof sac97.01.___.tar This creates the following directory structure (the contents of each directory are shown to the right): sac97.01 ; copy of this README file `-----bin ; compiled executable `-----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 sac97.01.source.tar.gz distribution (it is created during compilation). b) Source code is included only with the sac97.01.source.tar.gz distribution. c) It is recommended that no user files be kept in the sac97.01 directory structure. If you do plan to put files in the sac97.01 directory structure, do so only by creating subdirectories of sac97.01. 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 sac97.01.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 Makefile 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 sac97.01/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 sac97.01/bin and BINDIR if they do not already exist, b. compile the source code, c. place the executable (sac) in sac97.01/bin, and d. place a link to the executable in BINDIR if specified. D. INSTALLING To make the executable (sac) 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 sac97.01/src) contains instructions to optionally place a link in a specified directory to the executable contained in sac97.01/bin. Use the following two commands to do this: cd sac97.01/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 SAC executable file, the installer must have sufficient rights in the directory that BINDIR is set to. E. RUNNING THE SOFTWARE After SAC is properly installed in a directory that is included in your PATH, the program is initiated using the command: sac. SAC prompts for type of program input (currently only support WSPRO formatted data), input file name, output file name, and then run title. 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 "sac97.01/test" contains the scripts to run the tests. The directory "sac97.01/data" contains the input data and expected results for each test. Tests are run in the directory "sac97.01/test". Run the tests using any of the commands in the table below. To test the installation, change to the sac97.01/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=5 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 sac Slope-area reach example with level-water surface in cross sections SAC input data example1.dat i Program output example1.out o screen capture of test example1.log o 2 sac Slope-area reach: Snake Creek near Connell, Wash., for flood of February 21, 1956 SAC input data example2.dat i Program output example2.out o screen capture of test example2.log o 3 sac Sloping water surface with conveyance weighting SAC input data example3.dat i Program output example3.out o screen capture of test example3.log o 4 sac Slope-area reach example with level-water surface in cross sections, metric output SAC input data example4.dat i Program output example4.out o screen capture of test example4.log o 5 sac Simple reach example with metric input and feet-second output SAC input data example5.dat i Program output example5.out o screen capture of test example5.log o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *