June 3, 1997 LIBUTL Version 6.0 LIBDADIO - DADIO library Version 6.0 1997/02/05 LIBUTILS - Query library Version 6.0 1997/02/05 LIBCALGK - CalComp to GKS library Version 6.0 1997/02/05 LIBCALIN - CalComp to Interactor library Version 6.0 1997/03/13 LIBCALIN - Query library Version 6.0 1997/03/13 For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via e-mail at h2osoft@usgs.gov. See the file doc\libutl.txt for descriptions, references, and additional contacts for this software. Instructions for installation are provided below. This version of LIBUTL is packaged for use on personal computers using the DOS operating system. The installation procedures and the compiled version of LIBUTL must be used either in DOS directly or a DOS window within Microsoft Windows, Windows 95, or Windows NT. TABLE OF CONTENTS A. SYSTEM REQUIREMENTS B. DISTRIBUTION FILES C. INSTALLING o Installing LIBUTL from self-extracting executable o LIBUTL directory structure o Making LIBUTL easily accessible D. COMPILING A. SYSTEM REQUIREMENTS For installation of LIBUTL, about 3 megabytes of free disk space is needed. To use LIBUTL, the following are necessary: - 386 or greater processor - math coprocessor You must also allow for at least 20 files to be opened at one time. CONFIG.SYS must contain a line such as FILES=20 where the value assigned to FILES is 20 or greater. LIBUTL has been compiled using the Lahey Fortran 90 extended memory compiler version 3.00f. The file "LF90.EER" (from the Lahey compiler) located in libutl6.0\lib contains error messages. If an error occurs, this file is used to print error messages if the libutl6.0\lib directory is included in the PATH environment variable; if LF90.ERR cannot be found, the error will only be identified by number. B. DISTRIBUTION FILES LIBUTL is distributed as a package that contains the software 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. lbut6_0.exe - Compiled using Lahey Fortran 90 with source code lbut6_0b.exe - Compiled using Lahey Fortran 90 (binaries only) lbut6_0s.exe - Source code only The program source code consists of the following files: In the libutl6.0\src directory: calinter.for dastyp.cmn dim_lah.cmn intergh.inc loc_sgi.for calintio.for datdio.cmn dim_lf90.cmn intergs.inc loc_sun.for cindex.cmn digsblk.cmn dim_msf.cmn interif.inc opnsubs.for codmes.cmn digsgks.for dim_sgi.cmn intset.cmn pltsubs.for dadblk.cmn digssubs.for dim_sun.cmn loc_dgux.for print.cmn dadini.for digsubgk.for dstrf.cmn loc_dmy.for timsubs.for dadio.for digsublh.for getsubs.for loc_lah.for utilsubs.for dadiodmy.for digsubpc.for index.cmn loc_lf90.for dadiosub.for dim_dgux.cmn intergen.inc log_msf.for makefile -- input instructions to the Lahey "make" utility for compiling LIBUTL C. INSTALLING Installing LIBUTL from self-extracting executable ------------------------------------------------- For whichever LIBUTL distribution file that you have acquired, lbut6_0.exe, lbut6_0b.exe, or lbut6_0s.exe, the directory libutl6.0 is created (or overwritten) when the files are extracted. If the libutl6.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 LIBUTL 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: cd c:\wrdapp 2. Extract the files using the command: lbut6_0 -d -o :\[directory] Substitute "lbut6_0b" or "lbut6_0s" for "lbut6_0" if you are installing the compiled-code-only or source-code distributions, respectively. Note, be sure to include the -d (restore directory structure) and -o (overwrite existing files) options and ":\" in the command. Examples are: lbut6_0 -d -o c:\ lbut6_0 -d -o c:\wrdapp 3. Go to the newly-created libutl6.0 directory where the files have been extracted. For example: cd \wrdapp\libutl6.0 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 LIBUTL directory structure ----------------------- The following directory structure will be created (the contents of each directory are shown to the right): libutl6.0 ; copy of this README file `-----lib ; compiled libraries `-----doc ; documentation files `-----src ; makefile and source code Notes: a) The lib directory and compiled libraries are not included in the lbut6_0s.exe distribution file (they are created during compilation). b) The source code is not included in the lbut6_0b.exe distribution file. c) It is recommended that no user files are kept in the libutl6.0 directory structure. If you do plan to put files in the libutl6.0 directory structure, do so only by creating subdirectories of libutl6.0. d) Brackets "[xxx]" are used to indicate optional arguments to commands. Making LIBUTL easily accessible ---------------------------- To make the libutl libraries accessible from any directory, the directory containing the libraries 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:\libutl6.0\lib Note, substitute the appropriate drive letter and pathname if not C:\ as shown above. As an alternative, the LIBUTL libraries can be installed in a directory already included in the PATH environment variable. The makefile (input instructions to the Lahey make program--located in libutl6.0\src) contains instructions to optionally place a copy of the libraries contained in libutl6.0\lib in a specified directory. Use the following two commands to do this: cd libutl6.0\src make install BINDIR=directory_for_libraries For example: cd C:\libutl6.0\src make install BINDIR=C:\wrdapp\lib Note, the makefile may need to be modified to be used with make programs other than the Lahey make program. D. COMPILING The source code is provided in the lbut6_0.exe and lbut6_0s.exe distribution files so that users can generate the libraries 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 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 with Lahey's supplied make program. To generate new libraries, do the following: 1. Change directory to the source directory: cd libutl6.0\src 2. Modify the beginning of the file named makefile to correctly specify system-dependent variables: FFLAGS Fortran compiler flags FC Fortran compiler name OS Flag to select appropriate compiler or OS files 3. Provide the files loc_xx.for and dim_xx.cmn, where xx equals the string that the operating system name variable (OS) is set to in the makefile. These files contain system dependent routines and parameters. The file loc_xx.f contains subroutines that query the computer for the current date and time. The file dim_xx.cmn sets a parameter specifying the record length of a direct access file. Versions of loc_xx.f and dim_xx.cmn are included in the distribution for Data General, Silicon Graphics, and Sun workstations and Lahey and MicroSoft Fortran compilers. 4. Use the make program to initiate compilation of the source code and installation of the software: make [BINDIR=directory_for_libraries] NOTE: the INSTALLING instructions above explain the use of BINDIR. The make will: a. create the directory libutl6.0\lib if it does not exist, b. compile the source code, c. place the libraries (libdadio.lib, libutils.lib, libcal.lib, and libcalin.lib) in libutl6.0\lib, and d. place a copy of the libraries in BINDIR if specified. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *