BSDMS Bridge Scour Data Management System BSDMS - Version 2.1 1996/03/01 bsdms2_1.exe - self-extracting DOS distribution prepared on an IBM-compatible PC TABLE OF CONTENTS A. DESCRIPTION B. DOCUMENTATION C. SYSTEM REQUIREMENTS D. INSTALLING o Installing BSDMS from self-extracting executable o Installing BSDMS from distribution diskette o BSDMS directory structure o Making BSDMS easily accessible E. RUNNING THE PROGRAM F. SCREEN DISPLAY G. TESTING H. GRAPHICAL OUTPUT I. 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. A PostScript version of this report is available in the bsdms2.1\doc directory when BSDMS is installed from the self-extracting executable. C. SYSTEM REQUIREMENTS For installation of BSDMS, 7 megabytes of free disk space is needed. To run BSDMS, the following are necessary: - 386 or greater processor - math coprocessor - 7 megabytes of combined free extended memory and free disk space on installation drive (the greater proportion available as memory, the better performance will be) - at least 2 megabytes free disk space in current working directory D. INSTALLING Installing BSDMS from self-extracting executable ------------------------------------------------ To install BSDMS from the self-extracting executable, follow the steps below, replacing with the drive letter where you want to install BSDMS and optionally replacing [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: c: cd \wrdapp 2. Extract the files contained in the distribution file using the command: bsdms2_1 -d :\[directory] Note: be sure to include the -d option and ":\" in the command. Examples are: bsdms2_1 -d c:\ bsdms2_1 -d c:\wrdapp 3. Go to the newly-created bsdms2.1 directory where the files have been extracted. For example: c: cd \wrdapp\bsdms2.1 4. Complete the installation by typing, install :[\directory] using the same drive letter and directory name as for extracting the files; however, if the files are located in the root directory of the installation drive, don't include the backslash. Examples are: install c: install c:\wrdapp The above install command must run successfully in order to create the batch files, bsdms2.1\bin\bsdms.bat and bsdms2.1\test\bsdms.bat which are necessary for successful execution of BSDMS. Be sure that no errors occur when executing the above install command. Installing BSDMS from distribution diskette ------------------------------------------- To install BSDMS from distribution diskette onto your hard drive, type :install : :[\directory] For example, if your floppy drive is a: and you want to install BSDMS directly under the root directory on the c: drive, you would type a:install a: c: This will create the directory c:\bsdms2.1. As an additional example, if you wanted to install BSDMS under a directory named "wrdapp" on the c: drive, you would type a:install a: c:\wrdapp This will create the directory c:\wrdapp\bsdms2.1. BSDMS directory structure ------------------------- The following directory structure will be created (the contents of each directory are shown to the right): bsdms2.1 copy of this README file, installation batch file `-----bin compiled executable, batch file to run program `-----bin_data files required during execution `-----doc documentation files (not included on diskette) `-----database natpc.bsd for ~ 50 sites across the country `-----test batch file to run program; used to run verification tests `-----data standard data sets used in verification tests Note: 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. Making BSDMS easily accessible ------------------------------ To make the BSDMS program accessible from any directory, the bsdms2.1\bin directory should be included in the PATH environment variable. Add a line similar to the following to AUTOEXEC.BAT: PATH=%PATH%;C:\bsdms2.1\bin Substitute the appropriate drive letter and pathname if not C:\ as shown above. Reboot your system after modifying AUTOEXEC.BAT. E. RUNNING THE PROGRAM After the bsdms executable is properly installed (see INSTALLING, above), the program can be executed with the command "bsdms". F. SCREEN DISPLAY The program interface requires an ANSI standard terminal. You will know immediately upon program startup if you have a properly configured ANSI standard terminal--the borders outlining the components of the program screen will be properly drawn as solid lines. If you do not see solid lines outlining the program screen, but instead see a series of dashes or other characters (which may jumble the entire appearance of the screen), the ANSI.SYS device driver is not loaded. CONFIG.SYS must contain a line such as DEVICE = C:\DOS\ANSI.SYS Determine the location of the ANSI.SYS driver on your system and substitute the path name of that location if not C:\DOS as shown above. Note that for Windows 95, the ANSI.SYS driver is normally found in C:\WINDOWS\COMMAND. Reboot your system if you modify CONFIG.SYS. 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. Tests are run in the bsdms2.1\test directory. The directory bsdms2.1\data contains the input data and the expected results for each test. After each test is completed, compare the results to the expected results using a file comparison utility such as fc. If all goes well, there should be no differences. To clean up after the tests, type the command: clean 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. Run the tests by following the steps below. Test 1: - Attach to the bsdms2.1\test subdirectory and type "bsdms" to execute the program. - On the opening screen, type "@". In the small panel that appears, type "..\data\test1.log". BSDMS will be run using the keystrokes in ..\data\test1.log as if they were typed in. - The files test1.ot2 and test1.out should be produced in the bsdms2.1\test subdirectory. Compare these files to their counterparts in the bsdms2.1\data subdirectory. For example, if the fc command is available, test1.ot2 can be compared with its counterpart in the bsdms2.1\data directory by typing "fc ..\data\test1.ot2 test1.ot2". Test 2: - Execute the program by typing "bsdms" in the bsdms2.1\test subdirectory. - On the opening screen, type "@". In the small panel that appears, type "..\data\test2.log". BSDMS will be run using the keystrokes in ..\data\test2.log as if they were typed in. - The file test2.exp should be produced in the bsdms2.1\test subdirectory. Compare this file to the copy found in the bsdms2.1\data subdirectory. Test 3: - Execute the program by typing "bsdms" in the bsdms2.1\test subdirectory. - On the opening screen, type "@". In the small panel that appears, type "..\data\test3.log". BSDMS will be run using the keystrokes in ..\data\test3.log as if they were typed in. - The file test3.out should be produced in the bsdms2.1\test subdirectory. Compare this file to the copy found in the bsdms2.1\data subdirectory. 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. GRAPHICAL OUTPUT Graphical output is generated using the INTERACTER graphics library from Interactive Software Services, which is bundled in with the program executable. Graphical output may only be displayed on the screen--it is not possible to produce hardcopy of graphical output with the current version of BSDMS. I. CONTACTS Operation and Distribution: U.S. Geological Survey Hydrologic Analysis Software Support Team Michele Crouse 437 National Center Reston, VA 20192 h2osoft@usgs.gov Bridge Scour Data and Information: U.S. Geological Survey Kentucky District David S. Mueller 2301 Bradley Avenue Louisville, KY 40217 dmueller@usgs.gov