INSTALL

////////////////////////////////////////////////////////////////////////////

Step 0: Build any necessary third-party library as needed

AMPE requires the third-party packages hypre, Sundials, SAMRAI and Thermo4PFM.
These libaries are typically not pre-installed on most systems and need to be
installed.

Hypre:      https://github.com/hypre-space/hypre
Sundials:   https://github.com/LLNL/sundials
SAMRAI:     https://github.com/LLNL/SAMRAI
Thermo4PFM: https://github.com/ORNL/Thermo4PFM

Version requirements:
SAMRAI: version 4.1.0 or later, built with hypre, but without Sundials.
Sundials: version 5.4.0 to 5.8.0.

To build SAMRAI4.1.0 (with hypre), do something similar to this:
---------------------------------------------------------------

Download SAMRAI release from
https://computing.llnl.gov/projects/samrai/software#download
(includes BLT)

gunzip  SAMRAI-v4.1.0.tar.gz
cat SAMRAI-v4.0.0.tar|tar -xpf -
mv SAMRAI SAMRAI-v4.1.0

cd SAMRAI-v4.1.0
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release \
      -DCMAKE_CXX_COMPILER=mpiCC -DCMAKE_Fortran_COMPILER=mpif77 \
      -DHDF5_DIR=$HDF5_DIR -DHYPRE_DIR=$HOME/hypre/gnu-cpu \
      -DCMAKE_INSTALL_PREFIX=/home/q8j/SAMRAI/SAMRAI-v4.1.0 ..

make
make install

////////////////////////////////////////////////////////////////////////////

Step 1: Build the AMPE code with cmake

mkdir build
cd build

From the build directory, run a "cmake script". For example on condo@ORNL:

../scripts/build_condo_thermo4pfm_2d

where the solver dimension is specified (2d or 3d).
If a script does not exist for the platform-compiler_optimization
combination you want, you'll have to create your own using one of the
existing "cmake" scripts as an example.

Then run:
   make

It will create the main executable build/source/ampe2d (or ampe3d) as well
as executable unit tests.

////////////////////////////////////////////////////////////////////////////

Step 2: Run test suite

To run the test suite (unit + regression), run:
   make test

from the build directory.