Getting Started

Clone, build, and run ERF in a few steps:

git clone --recursive https://github.com/erf-model/ERF.git
cd ERF
# Customize (optional): export ERF_BUILD_DIR=... ERF_SOURCE_DIR=... ERF_INSTALL_DIR=... or ERF_HOME=...
ERF_HOME=$(pwd) ./Build/cmake_with_kokkos_many.sh

# Run from install directory
cd install/bin
mpiexec -n 4 ./erf_exec ../../Exec/CanonicalTests/ABL/inputs_most
On an HPC system? Start here instead.

Each tab sources a machine profile that handles environment setup, then runs the appropriate build script for that machine’s GPU backend. For download links and full job submission scripts, see Quickstart on HPC Systems.

git clone --recursive https://github.com/erf-model/ERF.git
cd ERF
source Build/machines/perlmutter_erf.profile
ERF_HOME=$(pwd) ./Build/cmake_with_kokkos_many_cuda.sh
cd install/bin
sbatch ../../Docs/sphinx_doc/scripts/quickstart/run_perlmutter_erf.sbatch

git clone --recursive https://github.com/erf-model/ERF.git
cd ERF
source Build/machines/kestrel_erf.profile
ERF_HOME=$(pwd) ./Build/cmake_with_kokkos_many_cuda.sh
cd install/bin
sbatch ../../Docs/sphinx_doc/scripts/quickstart/run_kestrel_erf.sbatch

git clone --recursive https://github.com/erf-model/ERF.git
cd ERF
source Build/machines/frontier_erf.profile
ERF_HOME=$(pwd) ./Build/cmake_with_kokkos_many_hip.sh
cd install/bin
sbatch ../../Docs/sphinx_doc/scripts/quickstart/run_frontier_erf.sbatch

git clone --recursive https://github.com/erf-model/ERF.git
cd ERF
source Build/machines/aurora_erf.profile
export NETCDF_DIR=<path-to-netcdf>
ERF_HOME=$(pwd) ./Build/cmake_with_kokkos_many_sycl.sh
cd install/bin
qsub ../../Docs/sphinx_doc/scripts/quickstart/submit_erf_aurora.pbs

Not on a listed machine? See Machine Profiles, Cray Detection, Build Scripts, and Workstation Builds for machine profile customization.

Need more detail? Choose the path that fits your situation: