README March 7, 1996 BSDMS Bridge Scour Data Management System BSDMS - Version 2.1 1996/03/01 bsdms2.1.DGUX.tar.gz - Distribution prepared on a Data General AViiON under DG/UX 5.4 bsdms2.1.source.tar.gz - Distribution that includes the source code but no compiled software TABLE OF CONTENTS A. DESCRIPTION B. DOCUMENTATION C. EXTRACTING FILES D COMPILING E. INSTALLING F. RUNNING THE PROGRAM G. TESTING H. CONTACTS A. DESCRIPTION The BSDMS has been developed to support preparation, compilation, and analysis of bridge-scour measurement data. Users may interactively store, retrieve, update, and display bridge scour and associated data. Help information provides descriptions of each of the more than 200 items that make up a data set for a bridge-scour site. These variables allow local pier scour, local abutment scour, contraction scour, and long-term scour measurements to be described. The data-set items cover all of the information for a given bridge: site data, measured data, flood event data, and channel geometry data. Program options permit comparison of observed scour depths with estimates from selected published scour equations. Data entered through menus and form fill-in screens are saved in a binary Bridge Scour Data, or BSD, file. These files are not compatible across different computer platforms but use of the "Archive" option allows data bases to be moved between platforms. B. DOCUMENTATION Landers, M.N., Mueller, D.S., and Martin, G.R., 1996, Bridge scour data management system user's manual: U.S. Geological Survey Open-File Report 95-754, 72 p. C. EXTRACTING FILES Compressed tar files are used to distribute pre-compiled versions of the software and the source code. All of the files needed to install bsdms2.1 are contained in the files bsdms2.1.______.tar.gz (where ______ is a string indicating the file contains either the source code or a pre-compiled version of the program for the indicated operating system). The source version of the tar file contains the source code and all other files needed to compile and install the software on a UNIX-based computer. For either type of distribution, the directory bsdms2.1 will be created (or overwritten) when the files are extracted from the tar tape. If the bsdms2.1 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. Steps in extracting files explanation --------------------------------------- ----------------------------------- mv bsdms2.1.____.tar.gz /usr/opt/wrdapp If the tar file is not already in the directory where you want the distribution installed, move it there. cd /usr/opt/wrdapp If you are not in the directory where the tar file is located, go there. gunzip bsdms2.1.____.tar.gz Uncompress the distribution file. tar xf bsdms2.1.____.tar Extract the distribution files from the tar file. This creates the following directory structure (the contents of each directory are shown to the right): bsdms2.1 copy of this README file `-----bin compiled executable `-----bin_data message file required during execution `-----doc documentation files (see file Contents) `-----database national.bsd for ~ 50 sites across the country `-----src Makefile (and, with source tar, the source code) `-----msg (with source tar, script & file to build message file) `-----test scripts to run verification tests `-----data standard data sets used in verification tests Notes: a) The bin_data and database subdirectories are not included in the bsdms2.1.source.tar.gz distribution; they are created during compilation. b) Source code is included only with the bsdms2.1.source.tar.gz distribution. c) It is recommended that no user files be kept in the bsdms2.1 directory structure. If you plan to put files in the bsdms2.1 directory structure, do so only by creating subdirectories under bsdms2.1. d) The software is configured for installation under the directory /usr/opt/wrdapp. The wrdapp directory may be a separate file system mounted at /usr/opt/wrdapp. If you choose to install the software elsewhere, you will need to retrieve the source version of the tar file and compile the software. e) To compile a new version of the software, you will also need: (1) libraries and other data files from the lib3.0 library (lib3.0.______.tar.gz), (2) ANSI-compliant Fortran 77 compiler, and (3) a Graphical Kernel System (GKS) library. D. COMPILING If you have retrieved a pre-compiled distribution of the software, skip to the Installing section below. 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. The source code is provided in the bsdms2.1.source.tar.gz distribution so that users can generate the executable themselves. Little or no support can be provided for users generating their own versions of the software. In general, the requirements are ANSI-compliant Fortran 77 and a minimum level of knowledge of the compiler and the UNIX operating system. Libraries and data files from the lib3.0 distribution are also required. As provided, the make file, source code, and text version of the message file are set up for use on Data General AViiON workstations running the DG/UX operating system. To generate the executable and message file, do the following: 1. The values for the indicated variables in the following bsdms2.1 files may need to be modified (see the file bsdms2.1/doc/versions.doc for more details): may need to be modified ------------------------------- version compiler file name variables flags name library --------------------- --------- ----------- ------- src/Makefile WrdA FFLAGS F77 LGks fscrms.inc FNAME msg/wdimex.sh WrdA test/test.sh WrdA 2. Run the Makefile program in the src directory to compile the source and build the message file. In the directory bsdms2.1/src, run the make: cd bsdms2.1/src make The bsdms2.1/src/Makefile will: a. Create the directories bsdms2.1/bin and bsdms2.1/database, if they do not already exist. b. Compile the source code and place the bsdms executable in the directory bsdms2.1/bin. c. Run the wdimex.sh script in bsdms2.1/msg to build the message file (bsdmss.wdm); the file is placed in bsdms2.1/bin_data. The national.bsd file is also built and placed in the bsdms2.1/database directory. E. INSTALLING To make the bsdms program easy to use, it should be installed in a directory included in the user's search path. The Makefile in bsdms2.1/src contains instructions to optionally place a link in a specified directory to the executable contained in bsdms2.1/bin. Use the following commands to do this: cd bsdms2.1/src make install [BINDIR=bin_path] where bin_path is the name of a directory in the user's search path. If BINDIR is specified, a link to the executable (bsdms2.1/bin/bsdms) is placed in the specified directory. If BINDIR is not specified, no link is set and the full pathname of the executable is required to run the program. For example, if the search path is /usr/bin:/usr/opt/bin:/usr/local/bin, you can use the following command to install the program: make install BINDIR=/usr/local/bin Notes: a) Brackets "[xxx]" are used to indicate optional arguments to commands. b) To create and delete links to the bsdms executable, the installer must have sufficient rights to the BINDIR directory. F. RUNNING THE PROGRAM After the bsdms executable is properly installed (see Installing, above) in a directory that is included in the user's PATH, the program can be executed with the command "bsdms". G. 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 bsdms2.1/test contains the scripts to run the tests. The directory bsdms2.1/data contains the input data and the expected results for each test. Tests are usually run in the bsdms2.1/test directory, but they can be run in any user directory. Type the following command to test the program installation: [path]/test.sh [start [stop]] where: path = path to the script use "." if running the tests in the bsdms2.1/test directory use full pathname if not running the test in bsdms2.1/test start = the number of the first test to perform default = 1 stop = the number of the last test to perform default = 3 For example: command what happens ------------------------------------- -------------------------------- ./test.sh runs all of the tests ./test.sh 1 1 runs the first test ./test.sh 2 2 runs test 2 /usr/opt/wrdapp/bsdms2.1/test/test.sh runs all of the tests After the tests are completed, the results are compared to the expected results (found in bsdms2.1/data). See the file check.out; if all goes well, there should be no differences. To clean up after the tests, type the command: ./clean.sh Notes: a) Test 2 requires input generated by test 1 and test 3 requires input generated by test 2, so the tests should be run in sequential order. b) 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, where '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 and o for output. test program description of test and files file name & usage ---- ------- --------------------------------- ----------------- 1 bsdms Build a Bridge Scour Data (BSD) file and enter data for a bridge site. bsdms command file test1.log i bridge scour data file test1.bsd o summary of bridge site data test1.out o pier scour computations test1.ot2 o 2 bsdms Archive a bridge site from the BSD file built in step 1. bsdms command file test2.log i bridge scour data file test1.bsd i archive file for bridge site test2.exp o 3 bsdms Import archived bridge site file to a new BSD file. bsdms command file test3.log i archive file of bridge scour data test2.exp i bridge scour data file test3.bsd o summary of bridge site data test3.out o H. CONTACTS Inquiries about this software should be directed to: U.S. Geological Survey Hydrologic Analysis Software Support Team Michele Crouse e-mail: h2osoft@usgs.gov 437 National Center phone: 703-648-5228 Reston, VA 22092 fax: 703-648-5722 Inquiries about bridge scour data and information shoud be directed to: U.S. Geological Survey Kentucky District David S. Mueller e-mail: dmueller@usgs.gov 2301 Bradley Avenue phone: 502-635-8030 Louisville, KY 40217