Storage Space on Hard Disc

A directory where the HST3D program package is to reside will need to be created. Installation will be done from within that directory. Installing the new version into a new directory is a good practice. Any previous versions of HST3D should be backed up, particularly if they contain any custom modifications to be ported over to the new version.

When unpacked, the Fortran 90 distribution requires roughly 12 MB of disc space for sources and example data sets, and 2 or 4 MB for documentation, depending on the format selected. About 8 MB of executable files and object files will be created and installed to their respective destinations. Once installation has been completed, disc space may be recovered by removing the files no longer needed, such as object files, or perhaps even source. Documentation might be removed once it has been printed.

Obtaining the Software

The source code for the HST3D simulator and the BCFLOW program with the makefiles, and example data files with selected output files can be obtained from either of two hosts on the Internet using the File Transfer Protocol (ftp) utility. The USGS software repository is at water.usgs.gov and the developer's public repository is at brrftp.cr.usgs.gov. Instructions for obtaining the distribution file from the USGS software repository are available at the USGS Water Resources Information web page at URL; http://water.usgs.gov/software/ground_water.html.

The procedure for obtaining the distribution file from the developer's repository is as follows:

1. Connect to the ftp server, brrftp.cr.usgs.gov.
2. Login as anonymous.
3. Change directory to pub/klkipp/hst3d.release.
4. Specify binary mode for transfer of a compressed file.
5. Download the compressed tar file, hst3d-2.m.n.tar.gz.
6. Download the documentation in the format desired, doc-2.pdf or doc-2.tar.gz (Postscript).

Installation Steps

1. Load the software

   Uncompress the tar file and extract the software. Several subdirectories will be created, three of which will be under the top-level installation directory. There will be makefiles in each of the top-level installation directory, the three second-level subdirectories, and the source (src) subdirectories.

2. Configure the makefiles

   Edit each of the five makefiles to set the particular options for the Fortran compiler and link editor to be used. The desired locations for the executable files also needs to be specified. The defaults are the three directories listed under BINDIR below.

   Makefile macros that often require customization:

   • SYSTEM_NAME - the name of the computer system where this installation is being done.
   • BINDIR - the installation directory for the executable modules (defaults are hst, and bcflow for the two programs). Write permission is needed for this directory.
   • MANDIR - the installation directory for the documentation (default is doc). Write permission is needed for this directory.
   • FDEBUG - a flag for the Fortran compile command used to specify debug compilation (usually -g).
   • FOPT - a flag for the Fortran compile command used to specify the level of optimization.
   • FFLAGS - a set of flags specifying options for the Fortran compiler.
   • LD_FLAGS - a set of flags specifying options for the link editor.

   Makefile macros that do not usually require change:

   • FC - the Fortran compile command.
   • LD - the load or link-edit command (The Fortran compiler can be invoked for link editing).

3. Compile and install HST3D and BCFLOW

   From the top-level installation directory, initiate the compilation and installation by typing, make all.

4. Test the installation

   After the installation process has finished, the HST3D simulator can be tested using the examples located in the hst/examples subdirectory. Each example with input data and selected output files is located in its own subdirectory. The BCFLOW program can be tested using the example located in the bcflow/examples/Ex.huyakorn subdirectory.

[Home]
[Previous]