Quickstart

Quickstart#

Tip

build_tsmp2.sh is a lightweight shell-script calling the CMake-based build-system. During execution of build_tsmp2.sh, the executed CMake-command is printed out. For advanced build use-cases, users can modify the outputted CMake command or directly head over to Building TSMP2 with CMake.

  1. Clone this repository.

git clone https://github.com/HPSCTerrSys/TSMP2.git
export TSMP2_DIR=$(realpath TSMP2)
cd $TSMP2_DIR

  1. Build model components with TSMP2 framework

To build a model component one need to activate the component model --<COMP>. The options are not case-sensitive and do not need to be in an specific order.

Note

The component models (git submodules) are cloned during the execution of build_tsmp2.sh. If the component model (models/<COMP>) are already exists, the user is asked if the folder should be overwritten or not. If you do want to use the default model component source codes, one can use the option --<COMP_SRC>.

# to see options
./build_tsmp2.sh --help

# ICON-eCLM-ParFlow
./build_tsmp2.sh --ICON --eCLM --PARFLOW

# eCLM-ParFlow
./build_tsmp2.sh --eCLM --PARFLOW

# ICON-eCLM
./build_tsmp2.sh --ICON --eCLM

# eCLM-PDAF
./build_tsmp2.sh --eCLM --PDAF

# ICON (with source code)
./build_tsmp2.sh --ICON --ICON_SRC ${ICON_SRC}

# ParFlow on Marvin (Uni Bonn)
./build_tsmp2.sh --ParFlow --env env/uni-bonn.gnu.openmpi