March 13, 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 LIBCAL - CalComp library for use with Lahey 6.0 1997/03/13 For assistance, enhancement requests, or bug reports contact the Hydrologic Analysis Software Support Team via email at h2osoft@usgs.gov. See the file doc/libutl.txt for descriptions, references, and additional contacts for this software. Instructions for installation, execution, and testing are provided below. TABLE OF CONTENTS A. DISTRIBUTION PACKAGES B. EXTRACTING FILES C. INSTALLING D. COMPILING A. DISTRIBUTION PACKAGES LIBUTL is distributed as a package that contains five libraries of routines (libutils--a set of prompting, file opening, time, and plotting utility routines; libdadio--a set of routines for using a Time-Dependent Data Base; libcalgk--a set of routines to convert CalComp graphics calls to Graphical Kernel System graphic calls; libcalin--a set of routines to convert CalComp graphics calls to INTERACTOR graphic calls; and libcal--a set of routines to resolve CalComp graphics calls for use with the basic Lahey graphics library), data sets, and information files. The software is available either uncompiled (source code), or compiled for one of two operating systems (contains the executable files, but not the source code). The following distribution packages are currently available for UNIX systems: libutl6.0.DGUX.tar.gz - Compiled for Data General AViiON under DG/UX 5.4 libutl6.0.Solaris.tar.gz - Compiled for Sun UltraSPARC 2 under Solaris 2.5 libutl6.0.source.tar.gz - Source code B. EXTRACTING FILES The compressed tar file, named libutl6.0.OS.tar.gz, contains all the files needed to install LIBUTL on a computer with a particular operating system, where, OS is a string indicating the operating system the distribution is intended for. If a version is not available for your operating system, the file libutl6.0.source.tar.gz 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 libutl6.0 is created (or overwritten) when the files are extracted from the tar file. 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 tar file. 1. If the tar file is not already in the directory under which you want the distribution installed, move it there. For example: mv libutl6.0.____.tar.gz /usr/opt/wrdapp 2. If you are not in the directory where the tar file is located, go there. For example: cd /usr/opt/wrdapp 3. Uncompress the distribution file. For example: gunzip libutl6.0.____.tar.gz 4. Extract the distribution files from the tar file. For example: tar -xpof libutl6.0.___.tar This creates the following directory structure (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 is not included in the libutl6.0.source.tar.gz distribution (it is created during compilation). b) Source code is included only with the libutl6.0.source.tar.gz distribution. c) It is recommended that no user files be 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. C. INSTALLING To make the libraries (libutils.a, libcalin.a, libcalgk.a and libdadio.a) easy to use, they should be installed in a directory included in the user's library search path. The Makefile (input instructions to the UNIX make program--located in libutl6.0/src) contains instructions to optionally place links in a specified directory to the libraries contained in libutl6.0/lib. Use the following two commands to do this (assuming you have the pre-compiled code or have compiled the code yourself): cd libutl6.0/src make install [BINDIR=directory_for_links] If BINDIR is specified, links to the libraries are placed in the specified directory. For example, if your search path consists of: /lib:/usr/lib: use the command: make install BINDIR=/usr/lib to make the libraries accessible from any directory without requiring the full pathname of the software's location. Notes: a) Brackets "[xxx]" are used to indicate optional arguments to commands. b) To create and delete links to the LIBUTL library files, the installer must have sufficient rights in the directory that BINDIR is set to. D. COMPILING If a compiled version of the software is not available for your computer, or if you want to build the libraries yourself, follow the instructions in this section. The source code is provided in the libutl6.0.source.tar.gz distribution 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 UNIX operating system. As provided, the Makefile and source code are set up for use on Data General AViiON workstations running the DG/UX operating system. 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: F77 Fortran compiler name FFLAGS Fortran compiler flags OS Operating system name SymTbl Symbol table option AR Creation command with options 3. Provide the files locsubs.xx.f and dimpar.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 locsubs.f contains subroutines that query the computer for the current date and time. The file dimpar.cmn sets a parameter specifying the record length of a direct access file. Versions of locsubs.f and dimpar.cmn are included in the distribution for Data General, Silicon Graphics, and Sun workstations. 4. Use the make program to initiate compilation of the source code and installation of the software: make [BINDIR=directory_for_links] NOTE: the Installing instructions above explain the use of BINDIR. The make will: a. create the directories libutl6.0/lib and BINDIR if they do not already exist, b. compile the source code, c. place the libraries (libdadio.a, libutils.a, libcalgk.a, and libcalin.a) in libutl6.0/lib, and d. place links to the libraries in BINDIR if specified. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Good Luck! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *