Developers

CMake is our primary build system. If you are new to CMake, this short tutorial from the HEP Software foundation is the perfect place to get started. If you just want to use CMake to build the project, jump into sections 1. Introduction, 2. Building with CMake and 9. Finding Packages.

Dependencies

Before you start, you will need a copy of the ExaEpi source code:

git clone https://github.com/AMReX-Codes/exaepi.git $HOME/src/exaepi
cd $HOME/src/exaepi

ExaEpi depends on popular third party software.

On your development machine, follow the instructions here.
If you are on an HPC machine, follow the instructions here.

Compile

From the base of the ExaEpi source directory, execute:

# find dependencies & configure
#   see additional options below, e.g.
#                   -DCMAKE_INSTALL_PREFIX=$HOME/sw/exaepi
cmake -S . -B build

# compile, here we use four threads
cmake --build build -j 4

That’s all! ExaEpi binaries are now in build/bin/. You can execute these binaries directly or copy them out.

You can inspect and modify build options after running cmake -S . -B build with either

ccmake build

or by adding arguments with -D<OPTION>=<VALUE> to the first CMake call, e.g.:

cmake -S . -B build -DAMReX_GPU_BACKEND=CUDA -DAMReX_HDF5=TRUE

Some of the options available are:

-DAMReX_GPU_BACKEND=CUDA: to build with GPU support.
-DAMReX_HDF5=TRUE: to write output as (compressed) HDF5. Parallel HDF5 is required, and the HDF5_CHUNK_SIZE environment variable should be set to a reasonable number before running the compiled code; 100,000 is recommended. For example, run export HDF5_CHUNK_SIZE=100000 before running the agent.