Quick Start

Quick Start#

This guide lets you install eCLM on the target machine.

Setting up eCLM on your local machine#

Download Podman.

  1. Fetch the eCLM container image. On your terminal, run the ff.:

WORKDIR=$HOME/eclm_container
mkdir $WORKDIR
podman run --name eclm-dev -it -v ${WORKDIR}:/root/$(basename ${WORKDIR}) hpscterrsys/eclm:latest-dev

  1. Build eCLM.

cd /root/eclm_container

# Download eCLM
git clone https://github.com/HPSCTerrSys/eCLM.git

# Build eCLM
cmake -S src -B bld -DCMAKE_INSTALL_PREFIX=$HOME/.local -DCMAKE_BUILD_TYPE="DEBUG"
cmake --build bld --parallel 4
cmake --install bld

  1. Set up a simulation experiment.

cd /root/eclm_container

# Generate namelists files.
git clone https://icg4geo.icg.kfa-juelich.de/ExternalReposPublic/tsmp2-static-files/extpar_eclm_wuestebach_sp.git wtb_data
cd wtb_data/static.resources/generate_wtb_namelists.sh /root/1x1_wuestebach

  1. Run eCLM.

cd /root/1x1_wuestebach
mpirun -np 1 eclm.exe

Setting up eCLM on HPC systems#

HPC at Forschungszentrum Jülich (Jülich Supercomputing Centre, JSC)#

The steps are similar to above. The only difference is the build step and running step.

  1. Download TSMP2 build system.

# eCLM can be easily built via the TSMP2 build system. The following step will download TSMP2.
git clone https://github.com/HPSCTerrSys/TSMP2.git

  1. Build eCLM

# Build eCLM
cd TSMP2
./build_tsmp2.sh eCLM

  1. Clone namelist files for the simulation experiment Wüstebach.

cd ..

# Download Wüstebach namelist configuration (internal repository, login needed)
git clone https://icg4geo.icg.kfa-juelich.de/Configurations/CLM/wtb_eclm.git 1x1_wuestebach

  1. Set up the executable and environment file with symlinks.

cd 1x1_wuestebach

# Symlink the eCLM executable and the JSC environment file
ln -s ../TSMP2/bin/JUWELS_eCLM/bin/eclm.exe eclm.exe
ln -s ../TSMP2/bin/JUWELS_eCLM/jsc.2025.intel.psmpi loadenvs

  1. Activate your JSC account

# Select a compute project with a non-empty 'budget-accounts'. If you don't have 
# one, request access via JuDOOR: https://judoor.fz-juelich.de
jutil user projects -u $USER

# Activate project
jutil env activate -p <account>

# Check if $BUDGET_ACCOUNTS was set
echo $BUDGET_ACCOUNTS

  1. Write the job script including your account information (automatically if $BUDGET_ACCOUNTS is set).

cat > jobscript.slurm << EOF
#!/usr/bin/env bash
#SBATCH --job-name=1x1_wuestebach
#SBATCH --nodes=1
#SBATCH --ntasks-per-node=48
#SBATCH --account=${BUDGET_ACCOUNTS}
#SBATCH --partition=dc-cpu
#SBATCH --time=0:30:00
#SBATCH --output=logs/%j.eclm.1x1_wuestebach.out
#SBATCH --error=logs/%j.eclm.1x1_wuestebach.err

# Load environment
source loadenvs

# Run model
srun -n 1 eclm.exe
EOF

  1. Run eCLM using the jobscript:

# On JSC systems (submit via Slurm):
sbatch jobscript.slurm

Generic HPC#

The steps are similar to above. The only difference is the build step and running step.

  1. Download TSMP2 build system.

# eCLM can be easily built via the TSMP2 build system. The following step will download TSMP2.
git clone https://github.com/HPSCTerrSys/TSMP2.git

  1. Build eCLM

# Build eCLM
cd TSMP2
./build_tsmp2.sh eCLM

  1. Set up a simulation experiment.

cd ..
git clone https://icg4geo.icg.kfa-juelich.de/ExternalReposPublic/tsmp2-static-files/extpar_eclm_wuestebach_sp.git
cd extpar_eclm_wuestebach_sp/static.resources
./generate_wtb_namelists.sh 1x1_wuestebach

# Download large files (possibly git-lfs needs to be configured)
cd ..
git lfs install
git lfs pull
cd static.resources

4b. Run eCLM.

cd 1x1_wuestebach
mpirun -np 1 eclm.exe