bapinfo.txt April Converse first version: 12may1992 last revised: 20apr1995 revised: 04nov1998 KF revised: 01mar1999 KF revised: 26jul2002 KF Information about the PC version of the BAP software Contents ======== 1. Introduction 2. Disclaimer 3. Acquiring the Software and User's Manual 4. Distribution Files 5. Upgrade Notices 6. Installation 7. Limitations and Known Bugs 8. Change History 9. Technical Support > Note: > 1) Much of the information in this file is also given in the > printed user's manual. Lines in this file that contain > information that are *newer* than that in the user's manual > are marked with angle brackets (>) in the left-hand margin. > 2) The 1999 version of the bapinfo.txt file is also included > as the file named bapinfo_1999.txt. This file contains > information that would be used if installing the program > from the original floppy diskettes or executables > BAPEXES.EXE, BAPAUX.EXE, and BAPCODE.EXE. 1. Introduction =============== The BAP computer program was developed at the U.S. Geological Survey (USGS) to process and plot digitized strong-motion earthquake records. BAP will calculate velocity and displacement from an input acceleration time series or it will calculate acceleration and displacement from an input velocity time series. The program will make linear baseline corrections, apply instrument correction, filter high frequency and/or low frequency content from the time series, calculate the Fourier amplitude spectrum, and calculate response spectra. It will also plot the results after each processing step. BAP can process time-series data files from the Strong-Motion CD-ROM that is also available from the USGS and should provide useful data processing functions to organizations outside the USGS that have acquired that CD-ROM. BAP will also process the recently- > acquired time-series files the USGS posts on the "nsmp.wr.usgs.gov" > computer on the Internet. The "nsmp.wr.usgs.gov" computer is > available for anonymous FTP access. The BAP program and various auxiliary support programs are available for PCs via the National Strong-Motion Project (NSMP) > "nsmp.wr.usgs.gov" computer on the Internet (see sections 3 & 4). > Both executable and source code is included among the distribution > files. The program has been verified to run in DOS mode on Windows > 95, 98, Me, and 2000 operating systems. 2. Disclaimer ============= Any use of trade, product, or firm names is for descriptive purposes only and does not imply endorsement by the USGS. Although this software has been used by the U.S. Geological Survey, no warranty, expressed or implied, is made by the USGS as to the accuracy and functioning of the software and related material, nor shall the fact of distribution constitute any such warranty, and no reponsibility is assumed by the USGS in connection therewith. 3. Acquiring the User's Manual and Software =========================================== The printed user's manual is available at a nominal price, payable in US funds, from: USGS Information Services Box 25286 Denver Federal Center Denver, Colorado, 80225-0046 Telephone: 1-303-202-4200 or 1-888-ASK-USGS (1-888-275-8747) Email: infoservices@usgs.gov Internet: http://mapping.usgs.gov/esic/to_order.html The user's manual is identified as USGS Open-File Report #92-296A, and is titled "BAP: Basic Strong-Motion Accelerogram Processing Software; Version 1.0". The price will vary over time, but in > 1998 the price for the user's manual was $25.25 for paper copy > plus $5 for shipping and handling. Users from non-profit > or research organizations outside the United States who find it > complicated to arrange to pay for the manual or US funds may > request a complimentary copy from the National Strong-Motion Data > Center staff (address is given at the end of this file). Note > that this manual is for version 1.0 of BAP. Users should view > the whatsnew.txt (or whatsnew.html) documentation for changes > from BAP Version 1.0 to Version 1.1. > The BAP software program (version 1.1) and "Whats new" > documentation is available via the National Strong-Motion Project > web site "http://nsmp.wr.usgs.gov/processing.html" or from > the NSMP ftp server "ftp://nsmp.wr.usgs.gov/software/bap/4pc" > as a downloadable zip file "bap.zip". The files included in this > zip file are available unzipped on the NSMP ftp server at > "ftp://nsmp.wr.usgs.gov/software/bap". The Strong-Motion CD-ROM is also available from the USGS Books and Open-File Reports Section. It is identified as USGS Digital Data Series #7 and is titled "Digitized Strong-Motion Accelerograms of North and Central American Earthquakes 1933-1986". Its 2000 price > was $32 plus $5 shipping and handling. The time series on the CD-ROM include all available ground-level uncorrected digital strong-motion records from North America written prior to the end of 1986. A CD-ROM reader is necessary to use the disk. 4. Distribution files ===================== > The BAP component files were originally broken up into three > archive files due to the limited disk space of "floppy" diskettes. > To facilitate the download and installation of BAP on newer PC > computers, the BAPEXES.EXE, BAPAUX.EXE, and BAPCODE.EXE files are > now zipped into one file, "bap.zip", that when unzipped will be > placed in the same subdirectories as the original diskettes. > The files included in the bap.zip file are the following: file name = contents --------- ------------- readme.txt = very brief introduction. bapinfo.txt = this file > whatsnew.txt = Update history. folder name = folder contents ----------- ------------- > exes = Executable files for BAP and the support programs. > examples, testdata, docs = Auxiliary files and miscellaneous > documentation. > gats, masmobjs, 4mps, 4msf, and 4L32v5 = The Fortran code and > related files that were used to create > the executable files. > The component files, when unzipped will be placed in the main > directory agram with several subdirectories named "exes", "docs", "testdata", examples", "gats", "masmobjs", "4msf", and "4L32". Sections E.5 and G.2 of the printed user's manual provides a > list and short description of the files. Some files that the user's > manual says should be in the subdirectories are not actually > available yet. They include "\agram\docs\help.txt" and > "\agram\docs\baprunp.txt" and probably others too. 5. Upgrade Notices ================== > This is version 1.1 of this software package, the first > upgrade to version 1.0. The user's manual was not updated in the > upgrade from version 1.0 to 1.1: Information about the differences > between this version and the previous version is given in the > whatsnew.txt file that in the \agram\docs directory. > Users can acquire the latest versions of the whatsnew.txt and > bapinfo.txt files from the "nsmp.wr.usgs.gov" Internet computer. 6. Installation =============== > The component files, when unzipped will be placed in the main > directory agram with several subdirectories named "exes", "docs", > "testdata", examples", "gats", "masmobjs", "4msf", and "4L32". > The BAP documentation assumes that the agram parent directory > resides on the C partition (C:\agram). Users who wish to place > the software on a different partition or location on C: will > need to make the appropiate changes to the installation tips > given below. > Uncompressed versions of these files are available from the NSMP > ftp server "ftp://nsmp.wr.usgs.gov/software/bap". Installation tips 1) Create a 4AGRAM.BAT file that you will invoke whenever you wish to run BAP or its auxiliary software without having to type the full pathname (ex: "C:\agram\exes\bap"). The 4AGRAM.BAT file should contain the following two statements: SET AGROOT=c:\AGRAM PATH=%AGROOT%\EXES;%PATH% and possibly a third statement: c:\AGRAM\EXES\MSHERC The first statement defines a new environment variable named AGROOT which is equivalent to "c:\AGRAM" and which indicates the parent directory below which all the BAP distribution files are located. The second statement adds the c:\AGRAM\EXES directory to the DOS PATH variable. (Note that this second statement must be executed from within a .BAT file; the %whatever% syntax will not work as intended if typed at the DOS command line.) The third statement should be included if and only if your computer uses a monochrome, Hercules-compatible monitor and video adaptor. If you have genuinely installed the distribution files at c:\AGRAM rather than on some other partition, and if you are *not* using a Hercules-compatible monochrome monitor, you can use the 4AGRAM.BAT file that is provided among the distribution files. To invoke it, simply type the following at the DOS prompt: dos> c:\AGRAM\EXAMPLES\4AGRAM.BAT If you have installed the programs on a disk partition other than C:, however, or you are using a Hercules monitor, you will need to make a copy of the distributed 4AGRAM.BAT file, then use a text editor (or the character-only mode of a word processor) to modify your copy to change the "c:" in there to the appropriate drive designator and/or to remove the leading comments from the "c:\AGRAM\EXES\MSHERC" line. Once you have modified your copy of 4AGRAM.BAT, invoke the commands therein: dos> 4AGRAM.BAT You will probably want to keep your copy of 4AGRAM.BAT in some directory other than \AGRAM or its subdirectories, so you can install new versions of this software, when they become available, without overwriting your special version of 4AGRAM.BAT. Or, you may want to include the commands in 4AGRAM.BAT within your AUTOEXEC.BAT file (See step 9). 2) Set your current directory to some empty directory (shown as C:\TEMP in this example) where there is room for you to generate a half-megabyte of temporary files: dos> C: (C: or wherever you like) dos> CD \TEMP (\TEMP or wherever you like) dos> DIR (is the directory empty?) 3) Verify that all has been installed properly by making some test runs. Try the following: dos> BAP dos> BAP SHOW dos> BAP c:\AGRAM\TESTDATA\GILROY21.SMC The first test "dos> BAP" will verify whether the 4AGRAM.BAT file has been configured correctly. It should result in a page of information on the screen with a brief introduction to BAP. The second test simply shows the default values of all the BAP run parameter values. The third test is an example of how you might use the software if you installed it merely to be able to display the time-series files from the Strong-Motion CD-ROM. By default, when nothing but a time-series data file name is given on its command line, BAP plots the time series to a PostScript file named BPPLOTS.APS. You can display the plot with the SCRPLOT command. For example: dos> SCRPLOT BPPLOTS.APS Or, to print the plot (the printer must be a postscript printer), use: dos> PRINT BPPLOTS.APS For a more thorough test, run the first example shown in appendix B of the printed user's manual. To do so, copy the GILROY21.BAT and GILROY21.BRP files to your current directory (which should still be C:\TEMP or a similar temporary directory): dos> COPY c:\AGRAM\EXAMPLES\GILROY21.* *.* Read the rest of the information for this step, then run the example simply by typing "GILROY21", or equivalently, "GILROY21.BAT" at the DOS prompt: dos> GILROY21.BAT Run messages will fly by the screen faster than you can read them (we hope!), but a copy of all the messages generated by the BAP command in GILROY21.BAT are saved in the file named G1RUN.MSG, where you can read them later. GILROY21.BAT will pause 3 times as it is running and ask you to "Press any key to Continue". The first pause asks you to consider whether it is OK for GILROY21.BAT to delete any *.APS files that may be in your current directory. (It should be OK to delete files, since you should be running this in an empty directory, but GILROY21.BAT asks just to make sure.) GILROY21.BAT pauses again after the BAP command, and again after the first of two PTSP commands, just to give you some sense of which messages you are watching on the screen. Note that the distributed version of GILROY21.BRP has the RESPON request commented out (because that step takes so much longer than all the other steps), so your GILROY21 test will not do the response spectra calculations shown in Appendix B of the user's manual (unless you remove the comment characters from the RESPON line). GILROY21.BAT should finish with a message that says: "+++ Done!". It should have generated the following files in your current directory: G1RUN.MSG a copy of the BAP run messages GILA.APS PostScript plot file GILB.APS " GILC.APS " G1INOUT.BBF BBF-format time series file from the BAP INPUT step G1ACC.BBF " LOCUT G1VEL.BBF " AVD G1DIS.BBF " AVD G1FAS.TXT Fourier amplitudes from the BAP FAS step You can display or print the plots in the .APS files as was indicated above for the BPPLOTS.APS file. Examples: dos> SCRPLOT GILA.APS dos> PRINT GILA.APS The printer must be a postscript printer for the above PRINT statement to work, however. If you wish to print the text files (G1RUN.MSG or G1FAS.TXT), you might have to convert them to PostScript format before printing them on a PostScript printer. The ASC2PS program distributed with this software will do the conversion. For example: dos> ASC2PS G1RUN.MSG TEMP.PS dos> PRINT TEMP.PS 4) Once you have verified that all is working properly, you may want to incorporate the definitions in 4AGRAM.BAT into your AUTOEXEC.BAT file, so these definitions will be made every time you boot or power up your computer. To do so, add a CALL c:\AGRAM\EXAMPLES\4AGRAM.BAT statement, or add the two or three non-comment statements in 4AGRAM.BAT, into AUTOEXEC.BAT *after* the last PATH statement already in AUTOEXEC.BAT. 7. Limitations ============== - TSPLOT can only read and plot BBF-format time-series files. So to plot the time series from some SMC-format files, one must pass each through BAP first to convert it to BBF format. Example: dos> BAP idc=zz, mydata.smc, input(f) dos> rename zzinout.bbf mydata.bbf dos> BAP idc=zz, yourdata.smc, input(f) dos> rename zzinout.bbf yourdata.bbf dos> PTSP mydata.bbf,yourdata.bbf,2.0,2.2,0.2, dots - Plotting functions could be improved: > = PC/TSPLOT aborts if it is given the same file name more than once > on the command line. You can get around this bug by making > several copies of the file. The error message you get when this > happens will remind you to make multiple copies of the file. > = TSPLOT is not very smart about synchronizing the time series > it is plotting. The plots in Figures 5.2.a and .b in the > BAP user's manual, for instance, won't come out right unless > all the curves have the same length leading pad. TSPLOT can > synchronize properly when the plot shows the beginning of > all the time series, however, as in Figures 5.3.a and .b. > = BAP should offer the user more control over the appearance of the > plots it generates. It is especially important to get the RESPON curves out on triaxial plots. I'd like to add a separate program (to be named RSPLOT?) that will plot the information in the BAPRESPON.TXT files (the output files from BAP's RESPON step) in a variety of ways. > = TSPLOT should offer the user more control over the appearance of > its plots too: > + it should be willing to remove the label that indicates the > pad length and origin time, if requested. > + user should be able to tell TSPLOT to plot an entire time > series on one page without needing to specify how long > the time series is. = The PC screen plotting programs (SFAS, STSP, SCRPLOT) don't handle characters very well. When the MODERN.FON file is available (it should be in \AGRAM\EXES), the characters are too small to read easily. When the MODERN.FON isn't there (or when user has SET MSFONTS=NO), the normal PC display characters are used rather than the graphic characters described in MODERN.FON. That is OK in itself, but the characters are positioned poorly. Users may prefer the screen display capability of current commercial postscript-interpreting software rather than the screen-plotting functions provided with the BAP distribution files. = The PC TXTMODE program could be more versatile. At present it gives you no choice of colors. You get blue background with white characters, no matter what. Use TXTMODE if an AGRAM screen-graphics program like STSP aborts on you (or if you abort it intentionally with CNTRL+C). TXTMODE resets the video mode from graphics to text. The screen will be a mess if a screen- graphics program aborts on a VGA or CGA monitor, so you'll know that something (TXTMODE!) needs to be done. On a Hercules- > compatible monochrome monitor, though, it's not quite so obvious > that the video system needs resetting: everything looks OK, but > the characters scroll by sluggishly, as though they were moving > through syrup. The DOS "mode" command can be used to reset the video mode too. = The .APS postscript processing could be faster and result in smaller .APS files. They have some other quirky behavior on occasion too, but not worth the space to elaborate here. > = Would like to be able to pass the printer's resolution to the > .APS file-generating subroutines. At present, the postscript in > the .APS files is tailored for 300 dot-per-inch printers. = Would like to be able to generate plot files that use the HP graphics language rather than PostScript, if the user requests such. Limitation that won't get fixed on DOS computers: > - Most of the support programs distributed with BAP are 16-bit, > DOS-compatible, "real-mode" programs that run within the 640k of > DOS conventional memory. BAP and PERL32, however, are 32-bit > "protected-mode" programs that run in extended memory with the help > of "DOS-extending" software. (BAP version 1.1 uses the "PharLap" > DOS extender; BAP version 1.0 used "Ergo OS386"; and Perl32 uses > Rational Systems' "DOS/4GW".) The 32-bit programs can hang one's > PC when it is configured to use extended memory for another purpose > (like a RAM disk). Refer to the file at \agram\docs\atboots.doc > for information about setting up alternative configurations. 8. Change History ================= next: See the whatsnew.txt file for info. 20apr95: BAP version 1.1 12may92: BAP version 1.0 is a new program. 9. Technical Support ==================== Questions regarding BAP should be addressed to: Chris Stephens Kent Fogleman e-mail: cdstephens@usgs.gov fogleman@usgs.gov phone: 1-650-329-4752 1-650-329-4745 post office address: USGS, MS 977 345 Middlefield Road Menlo Park, CA 94025 USA