Skip to content

Installation

Jeremiah Goates edited this page Nov 1, 2023 · 1 revision

Obtaining the Code

HI-Mach is currently not available for public release

Prerequisites

  • A Fortran compiler. We have developed HI-Mach using the gfortran compiler
  • OpenMP (usually comes with gfortran) and make.
  • We recommend ParaView for data visualization. It can be downloaded here.

Installation

Linux

On Linux systems, open the terminal and navigate to the HI-Mach directory. Simply execute

make

Windows

On Windows systems, HI-Mach requires the installation of certain compiler suites. Once the compiler suites are installed, open the terminal and navigate to the HI-Mach directory. Simply execute

make

Mac

HI-Mach has not yet been tested on Mac systems. Please try it out and let us know what (if any) issues you have.

Testing the Installation

For unit tests, we use pytest. Information on installing Python and the pytest module may be found here. Once pytest is installed, unit tests are run from the main HI-Mach directory simply by executing

py.test test/

Make Options

The Makefile has several compilation options:

Option
default Standard parallel compilation.
debug Parallel compilation with some helpful flags added for debugging. Should be used by developers.
wall debug on steroids. Makes the compiler tell you everything you've even thought about doing wrong. Very helpful for cleaning up unused variables. Not recommended for everyday developing.
serial Standard compilation in serial (i.e. doesn't include the OpenMP flag).
debug-serial Same as debug but without the OpenMP flag.
clean Removes all compiled files.