Building ERF

ERF supports two build systems: GNUMake and CMake.

To use GNU Make, cd into ERF/Exec and type make. (Developers adding new features may wish to work in problem- or feature-specific directories in ERF/.Exec_dev instead; for these cases one would build in that directory in ERF/.Exec_dev.)

When on Cray HPC platforms like Perlmutter, CMake provides automated detection to simplify configuration. To use cmake, one typically creates an ERF/build directory, copies an cmake file from ERF/Build, and runs cmake in ERF/build.

This page provides quick-start commands; comprehensive documentation follows in the sections below.

Where to start:

Quick Start

Most common builds:

# GNU Make with GNU compiler and MPI
make COMP=gnu USE_MPI=TRUE

# GNU Make with GPU support
make COMP=gnu USE_MPI=TRUE USE_CUDA=TRUE

# CMake configuration script
cd Build && ./cmake.sh

Cleanup:

# GNU Make
make clean

# CMake
cd Build && make distclean

Documentation structure: