June 3, 1997 TDDS Time-Dependent Data System TDDS - Version: 6.0 1997/03/06 DAPLOT - Version 6.1 1997/03/06 XYPLOT - Version 1.2 1997/03/06 DAFILE - Version 6.0 1997/02/06 BACKUP - Version 5.1 1996/04/29 DAFIX - Version 5.5 1996/06/26 DAGET - Version 5.1 1996/04/22 SUMMARY - Version 5.0 1996/02/15 For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc\tdds.txt for descriptions, references, and additional contacts for this software. Instructions for installation, execution, and testing are provided below. This version of TDDS is packaged for use on personal computers using the DOS operating system. The installation procedures and the compiled version of TDDS must be run using either DOS directly or a DOS window within Microsoft Windows, Windows 95, or Windows NT. TABLE OF CONTENTS A. DISTRIBUTION PACKAGES B. EXTRACTING FILES C. COMPILING D. INSTALLING E. RUNNING THE SOFTWARE F. TESTING A. DISTRIBUTION PACKAGES TDDS is distributed as a package that contains the software (tdds), data sets, and information files. The software is available either uncompiled (source code), compiled only, or compiled plus source code. The following self-extracting DOS distribution files are currently available. tdds6_0.exe - Compiled using Lahey Fortran 90 with source code tdds6_0b.exe - Compiled using Lahey Fortran 90 (binaries only) tdds6_0s.exe - Source code only B. EXTRACTING FILES For whichever TDDS distribution file that you have acquired, tdds6_0.exe, tdds6_0b.exe, or tdds6_0s.exe, the directory tdds6.0 is created (or overwritten) when the files are extracted. If the tdds6.0 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 file. Note, replace with the drive letter where you want to install TDDS and optionally replace [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 (if already on the C disk drive): cd c:\wrdapp 2. Extract the files using the command: tdds6_0 -d -o :\[directory] Substitute "tdds6_0b" or "tdds6_0s" for "tdds6_0" if you are installing the executable-code-only or source-code-only distributions, respectively. Note, be sure to include the -d (restore directory structure) and -o (overwrite existing files) options and ":\" in the command. Examples are: tdds6_0 -d -o c:\ tdds6_0 -d -o c:\wrdapp The following directory structure will be created (the contents of each directory are shown to the right): tdds6.0 ; copy of this readme file `-----bin ; compiled executable and Lahey error file `-----doc ; documentation files `-----src ; makefile and source code `-----test ; batch files to run verification tests `-----data ; standard data sets used in verification tests Notes: a) The bin directory is not included in the tdds6_0s.exe distribution file (it is created during compilation). b) The executable is not included in the tdds6_0s.exe distribution file. c) The source code is not included in the tdds6_0b.exe distribution file. d) It is recommended that no user files are kept in the tdds6.0 directory structure. If you do plan to put files in the tdds6.0 directory structure, do so only by creating subdirectories of tdds6.0. e) Brackets "[xxx]" are used to indicate optional arguments to commands. C. COMPILING The source code is provided in the tdds6_0.exe and tdds6_0s.exe distribution files 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, utility library libutl6.0 (which includes screen prompting, device independent graphics, and Time-Dependent Data Base routines), partial CalComp graphics software, and a minimal level of knowledge of the compiler and the DOS operating system. As provided, the makefile and source code are optimized for use on a Pentium personal computer using the Lahey Fortran 90 compiler and Lahey supplied make program. The TDDS program graphics are written using CalComp calls; the LIBUTL library includes routines to resolve some of these CalComp calls. Other CalComp calls (PLOTS, PLOT, NEWPEN, and FACTOR) must be provided by the user. The Lahey graph90 library contains these calls. The LIBUTL library also includes routines that translate CalComp calls to INTERACTOR calls. The makefile is coded to use the CalComp to INTERACTOR graphics library. If another CalComp library is available, TDDS and the makefile could easily be modified to use it, rather than the default configuration. To generate a new executable, do the following: 1. Change directory to the source directory: cd tdds6.0\src 2. Modify the beginning of the file named makefile to correctly specify system-dependent variables: GRAPHLIB Graphics libraries LibDir Top-level directory for LIBUTL software FFLAGS Fortran compiler flags FC Fortran compiler name LINKER Fortran linker name LNKFLGS Fortran linker flags 3. Use the make program to initiate compilation of the source code and installation of the software: make [BINDIR=directory_for_executable] See the Installing instructions below for an explanation of BINDIR. The make will: a. create the directory tdds6.0\bin if it does not exist, b. compile the source code, c. place the executable (tdds.exe) in tdds6.0\bin, and d. place a copy of the executable in BINDIR if specified. D: INSTALLING To make the TDDS program accessible from any directory, the directory containing the executable should be included in the PATH environment variable. For example, you could add a line similar to the following to the AUTOEXEC.BAT file: PATH=%PATH%;C:\tdds6.0\bin Note, substitute the appropriate drive letter and pathname if not C:\ as shown above. As an alternative, the TDDS executable can be installed in a directory already included in the PATH environment variable. The makefile (input instructions to the Lahey make program--located in tdds6.0\src) contains instructions to optionally place a copy of the executable contained in tdds6.0\bin in a specified directory. Use the following two commands to do this: cd tdds_source_directory make install BINDIR=directory_for_executable For example: cd C:\tdds6.0\src make install BINDIR=C:\wrdapp\bin Note, the makefile may need to be modified to be used with make programs other than the Lahey make program. E. RUNNING THE SOFTWARE **System Requirements** - 386-based or higher personal computer with math co-processor - 4 MB application RAM - 4 MB disk space TDDS has been compiled using the Lahey Fortran 90 extended memory compiler version 3.00f. The file "LF90.EER" (from the Lahey compiler) located in tdds6.0\bin contains error messages. If an error occurs, this file is used to print error messages if the tdds6.0\bin directory is included in the PATH environment variable; if LF90.ERR cannot be found, the error will only be identified by number. After TDDS is properly installed in a directory that is included in your PATH, the program is initiated using the command: tdds. TDDS is an interactive prompting program. The data base and data station reference files that were last used with TDDS in the curent directory are retained in a "master" file for subsequent use. Input files may be pre-coded or created interactively during a TDDS session. 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 tdds6.0\test contains batch files to run the tests. The directory tdds6.0\data contains the input data and expected results for each test. Run the tests in the tdds6.0\test directory using the command: test After the tests are completed, the results can be compared to the expected results. If all has gone well, the only differences will be due to different processing times or pathnames. To clean-up after the tests, type the command: clean 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 tdds This test initiates a TDDB (tdds1.tdd) builds a DSR file (tdds1.dsr), loads two data sets, produces a directory, summary listing, creates a backup of an existing TDDB, adds some stations to an existing DSR file, restores a backed up TDDB, corrects a data value, retrieves data and formats it in four different output formats, and produces plots of two data sets. program-control file allocate.rdr i allocate output file allocate.prt o program-control file summary1.rdr i summary output file summary1.prt o program-control file summary2.rdr i summary output file summary2.prt o program-control file backup1.rdr i backup output file backup1.prt o program-control file backup2.rdr i backup output file backup2.prt o program-control file backup3.rdr i backup output file backup3.prt o program-control file dafix1.rdr i dafix output file dafix1.prt o program-control file daget1.rdr i daget output file daget1.prt o program-control file daget2.rdr i daget output file daget2.prt o program-control file daget3.rdr i daget output file daget3.prt o program-control file daget4.rdr i daget output file daget4.prt o program-control file daplot1.rdr i daplot output file daplot1.prt o program-control file daplot2.rdr i daplot output file daplot2.prt o data set to store in TDDB dataset.1 i data set to store in TDDB dataset.2 i Binary backup copy of TDDB BACKUP.TDD i/o DSR file for Potomac River data potomac.dsr i TDDB for Potomac River data potomac.tdd i TDDS response file to run tests tdds1.dat i Master file of TDDB and DSR names TDDB_DSR.MTR i/o TDDB created during tests tdds1.tdd i/o DSR file created during tests tdds1.dsr i/o CalComp/INTERACTOR configuration plot.ini i/o 2 tdds This test initiates a TDDB (example.tdd) builds a DSR file (example.dsr), loads two data sets, and produces a directory, summary listing. program-control file dafile2.rdr i dafile output print file dafile2.prt o program-control file xyplot1.rdr i dafile output print file xyplot1.prt o DSR file for test example.dsr i/o TDDB for test example.tdd o TDDS response file to run tests tdds2.dat i CalComp/INTERACTOR configuration plot.ini i/o * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *