HST3D


Unix Platform

Obtaining the Software

The Unix distribution package containing the Fortran source files for the HST3D simulator and the BCFLOW program with the example data files including selected output files can be obtained from the HST3D Download: list.

Download the latest distribution package.

Note: If you are using Mozilla Firefox as your Internet browser, right click on the file that you are downloading. Choose Save Link As ... to download the file.

Unpacking the Software

The installation of the HST3D software involves uncompressing and unpacking the distribution. First create and change to the directory chosen for building and installing HST3D. The minimum disc space required to build and install HST3D is 16 MB. Note that the distribution package will unpack into a top level directory named hst3d-v.r. Several subdirectories will be created. This download is in compressed tar format. To unpack, use a command like:
gunzip hst3d-v.r.p.tar.gz | tar -xvf - or
tar -xzf hst3d-v.r.p.tar.gz

Building the Simulator Executable

Building the executable files for HST3D and BCFLOW is necessary for each Unix platform. The prerequisite for building is a Fortran-90 compiler. About 3.6 MB of executable files and 2.5 MB of object and module files will be created. Please see the README and INSTALL files in the distribution package for the most up-to-date information and instructions.
To build HST3D and BCFLOW from source code:

  1. Change the working directory to hst/src.
  2. Edit the Makefile in the hst/src directory to specify the local Fortran compiler and appropriate compiler flags.
  3. Edit the Makefile to change the installation location of the executable, if desired. The default is one level above the hst/src directory.
  4. Change the working directory to hst3d-2.2.
  5. Type make all to compile the programs for HST3D and BCFLOW.
  6. Type make install to install the executable files for HST3D and BCFLOW.

After the installation process has finished, the HST3D simulator can be tested using the examples located in the hst3d-v.r/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. Note that the executable program files are located two directory levels above the example file locations.

To test the HST3D simulator:

  1. Change to one of the hst/examples/Ex. directories.
  2. Run the example by invoking HST3D, ../../hst3d, and entering the name of the data file and a suffix for the output files (different from the sample files provided) when prompted.
  3. Compare the results to the sample output files provided.

To test the BCFLOW program:

  1. Change to the bcflow/examples/Ex.huyakorn directory.
  2. Run the example by invoking BCFLOW, ../../bcflow, and entering the name of the data file, a suffix for the Bcnfr file, and a suffix for the output files (different from the sample files provided) when prompted.
  3. Compare the results to the sample output files provided.

Uninstalling the Software

Remove the entire software installation with the following steps:

  1. Change the working directory to the one containing the top-level installation directory, hst3d-2.2.
  2. Remove the installed program package using a command like:
    rm -rf hst3d-2.2



Linux Platform

Obtaining the Software

The Linux distribution package containing the executable and the Fortran source files for the HST3D simulator and the BCFLOW program with the example data files including selected output files can be obtained from the HST3D Download: list.

Download the latest distribution package.

Note: If you are using Mozilla Firefox as your Internet browser, right click on the file that you are downloading. Choose Save Link As ... to download the file.

Installing the Software

The installation of the HST3D software normally only involves uncompressing and unpacking the distribution. First create and change to the directory chosen for installing HST3D. The minimum disc space required to install HST3D and BCFLOW is 13 MB. Note that the distribution package will unpack into a top level directory named hst3d-v.r. Several subdirectories will be created. This download is in compressed tar format. To unpack, use a command like:
gunzip hst3d-v.r.p.tar.gz | tar -xvf - or
tar -xzf hst3d-v.r.p.tar.gz

After the installation process has finished, the HST3D simulator can be tested using the examples located in the hst3d-v.r/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. Note that the executable program files are located two directory levels above the example file locations.

To test the HST3D simulator:

  1. Change to one of the hst/examples/Ex. directories.
  2. Run the example by invoking HST3D, ../../hst3d, and entering the name of the data file and a suffix for the output files (different from the sample files provided) when prompted.
  3. Compare the results to the sample output files provided.

To test the BCFLOW program:

  1. Change to the bcflow/examples/Ex.huyakorn directory.
  2. Run the example by invoking BCFLOW, ../../bcflow, and entering the name of the data file, a suffix for the Bcnfr file, and a suffix for the output files (different from the sample files provided) when prompted.
  3. Compare the results to the sample output files provided.

Building the Simulator Executable

This section describes how to build and install the HST3D and BCFLOW executable files. Building the executable normally follows making changes to the source code. Prerequisite for building is a Fortran-90 compiler. About 3.6 MB of executable files and 2.5 MB of object and module files will be created. Please see the README and INSTALL files in the distribution package for the most up-to-date information and instructions.
To build HST3D and BCFLOW from source code:

  1. Change the working directory to hst/src.
  2. Edit the Makefile in the hst/src directory to specify the local Fortran compiler and appropriate compiler flags.
  3. Edit the Makefile to change the installation location of the executable, if desired. The default is one level above the hst/src directory.
  4. Change the working directory to hst3d-2.2.
  5. Type make all to compile the programs for HST3D and BCFLOW.
  6. Type make install to install the executable files for HST3D and BCFLOW.

Uninstalling the Software

Remove the entire software installation with the following steps:

  1. Change the working directory to the one containing the top-level installation directory, hst3d-2.2.
  2. Remove the installed program package using a command like:
    rm -rf hst3d-2.2

PC Windows Platform

Obtaining the Software

The Windows distribution package containing the executable for the HST3D simulator and the BCFLOW program with the example data files with selected output files can be obtained from the HST3D Download: list.

Download the latest distribution package.

Note: If you are using Mozilla Firefox as your Internet browser, right click on the file that you are downloading. Choose Save Link As ... to download the file.

Note: If you are using Internet Explorer as your Internet browser, right click on the file that you are downloading. Choose Save Target As ... to download the file.

Installing the Software

The installation of the HST3D software normally only involves uncompressing and unpacking the distribution. The minimum disc space required to install HST3D and BCFLOW is 11 MB. Note that the distribution package will unpack into a top level directory named hst3d-v.r. Several subdirectories will be created. This download package is in .zip file format. You must be running Microsoft Windows XP or later. Right click on the filename and select the Extract All item. Follow the instructions in the pop-up dialog box.Several subdirectories will be created, three of which will be under the top-level installation directory.

After the installation process has finished, the HST3D simulator can be tested using the examples located in the hst3d-v.r/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. Note that the executable program files are located two directory levels above the example file locations.

To test the HST3D simulator:

  1. Open a window to use as a command line interface.
  2. Change to one of the hst/examples/Ex. directories.
  3. Run the example by invoking HST3D, ../../hst3d.exe, and entering the name of the data file and a suffix for the output files (different from the sample files provided) when prompted.
  4. Compare the results to the sample output files provided.

To test the BCFLOW program:

  1. Change to the bcflow/examples/Ex.huyakorn directory.
  2. Run the example by invoking BCFLOW, ../../bcflow, and entering the name of the data file, a suffix for the Bcnfr file, and a suffix for the output files (different from the sample files provided) when prompted.
  3. Compare the results to the sample output files provided.

Uninstalling the Software

Remove the entire software installation with the following steps:

  1. As a user with administrator privileges run: Start->Control Panel->Add or Modify Program.
  2. Select hst3d in the window that appears.
  3. Click on the Remove button.