build_tsmp2.sh

#!/usr/bin/env bash
### TSMP2 frontend
### Shell-based script to compile model components within the TSMP2 framework.
###
### For more information:
### ./build_tsmp2.sh --help

# Force script to exit when error occurs
set -eo pipefail

## functions

function help_tsmp2() {
  echo "Usage: $0 [-v ] [--component_name] [--optionals]"
  echo "  -q, --quiet      Write less output during shell execution"
  echo "  -v, --verbose    Enable verbose output from Makefile builds using CMAKE_VERBOSE_MAKEFILE"
  echo "  --version        Print $0 scipt version"
  echo "  --ICON           Compile with ICON"
  echo "  --eCLM           Compile with eCLM"
  echo "  --ParFlow        Compile with ParFlow"
  echo "  --PDAF           Compile with PDAF"
  echo "  --COSMO          Compile with COSMO"
  echo "  --CLM35          Compile with CLM3.5"
  echo "  --ICON_SRC       Set ICON_SRC directory"
  echo "  --eCLM_SRC       Set eCLM_SRC directory"
  echo "  --ParFlow_SRC    Set ParFlow_SRC directory"
  echo "  --OASIS_SRC      Set OASIS3-MCT directory"
  echo "  --PDAF_SRC       Set PDAF_SRC directory"
  echo "  --build_type   Set build configuration: 'DEBUG' 'RELEASE'"
  echo "  --compiler       Set compiler for building"
  echo "  --build_dir      Set build dir cmake, if not set bld/<SYSTEMNAME>_<model-id> is used. Build artifacts will be generated in this folder."
  echo "  --install_dir    Set install dir cmake, if not set bin/<SYSTEMNAME>_<model-id> is used. Model executables and libraries will be installed here"
  echo "  --tsmp2_env      Set model environment."
  echo ""
  echo "Example: $0 --ICON --eCLM --ParFlow"
  exit 1
}

function set_component(){
local -n component=$1
cmake_name=$2
if [ "${component}" = "y" ];then
  if [ ! "${model_id}" ];then
      model_id="${cmake_name}"
  else
      model_id+="-${cmake_name}"
  fi # model_id
  cmake_comp_str+=" -D${cmake_name}=ON"
  if [[ $cmake_name = @(ICON|eCLM|ParFlow|COSMO|CLM3.5) ]]; then
     model_count=$(( $model_count + 1 ))
  fi # cmake_name
fi # component
}

function set_compsrc(){
local -n compsrc_name=$1
cmake_srcname=$2
if [ -n "${compsrc_name}" ];then
  cmake_compsrc_str+=" -D${cmake_srcname}=${compsrc_name}"
fi # compsrc
}

function dwn_compsrc(){
comp_name=$1
local -n comp_namey=$1
local -n comp_srcname=$2
sub_srcname=$3
if [ -n "${comp_namey}" ] && [ -z "${comp_srcname}" ];then
  if [ "${sub_srcname}" = "parflow" ] && [ -n "${pdaf}" ];then
     submodule_name=$(echo "models/${sub_srcname}_pdaf")
  else
     submodule_name=$(echo "models/"${sub_srcname})
  fi
  if [ "$( ls -A ${cmake_tsmp2_dir}/${submodule_name} | wc -l)" -ne 0 ];then
     read -p "submodule ${submodule_name} aleady exists. Do you want overwrite it? (y/n) " yn
     if [ "${yn,}" = "y" ];then
        message "Overwrite submodule ${submodule_name}"
        git submodule update --init --force -- ${submodule_name}
     else
        message "Do not overwrite submodule ${submodule_name}"
     fi
  else
     git submodule update --init -- ${submodule_name}
  fi
fi # compsrc
}

function message(){
if [ -z "${quiet}" ];then
  echo "$1"
fi # quiet
}

###
## PROGRAM START
###

## get params
while [[ "$#" -gt 0 ]]; do
    case "${1,,}" in
	-h|--help) help_tsmp2;;
	-q|--quiet) quiet=y;;
	-v|--verbose) verbose_makefile=y;;
	--version) echo "$0 version 0.1.0"; exit 1;;
        --icon) icon=y;;
        --eclm) eclm=y;;
	--parflow) parflow=y;;
	--pdaf) pdaf=y;;
	--cosmo) cosmo=y;;
	--clm35) clm35=y;;
	--icon_src) icon_src="$2"; shift ;;
	--eclm_src) eclm_src="$2"; shift ;;
	--parflow_src) parflow_src="$2"; shift ;;
	--cosmo_src) cosmo_src="$2"; shift ;;
	--clm35_src) clm35_src="$2"; shift ;;
	--pdaf_src) pdaf_src="$2"; shift ;;
	--oasis_src) oasis_src="$2"; shift ;;
	--build_type) build_type="$2"; shift ;;
	--compiler) compiler="$2"; shift ;; 
	--build_dir) build_dir="$2"; shift ;;
	--install_dir) install_dir="$2"; shift ;;
	--tsmp2_env) tsmp2_env="$2"; shift ;;
        *) echo "Unknown parameter passed: $1"; exit 1 ;;
    esac
    shift
done

# Get tsmp2_dir (full path) from location of $0
cmake_tsmp2_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

## Create MODEL_ID + COMPONENT STRING
model_id=""
model_count=0
cmake_comp_str=""

message "Setting model-id and component string..."
# fun set_component shell_name cmake_name
set_component icon "ICON"
set_component eclm "eCLM"
set_component parflow "ParFlow"
set_component cosmo "COSMO"
set_component clm35 "CLM3.5"
set_component pdaf "PDAF"

if [ $model_count = 0 ];then
  echo "ABORT: No model component is chosen"
  exit 1
elif [ $model_count -ge 2 ];then
  oasis=y
fi

## CONCADINATE SOURCE CODE STRING
message "Setting component source dir..."
cmake_compsrc_str=""
set_compsrc icon_src "ICON_SRC"
set_compsrc eclm_src "eCLM_SRC"
set_compsrc parflow_src "PARFLOW_SRC"
set_compsrc oasis_src "OASIS_SRC"
set_compsrc pdaf_src "PDAF_SRC"
set_compsrc cosmo_src "COSMO_SRC"
set_compsrc clm35_src "CLM35_SRC"

## download model components
dwn_compsrc icon icon_src "icon"
dwn_compsrc eclm eclm_src "eCLM"
dwn_compsrc parflow parflow_src "parflow"
dwn_compsrc oasis oasis_src "oasis3-mct"
dwn_compsrc pdaf pdaf_src "pdaf"
dwn_compsrc cosmo cosmo_src "cosmo"
dwn_compsrc clm35 clm35_src "CLM3.5"

## CMAKE options

message "Setting CMAKE options..."
# build_type
if [ -z "$build_type" ];then
   cmake_build_type=""
else
   cmake_build_type=" -DCMAKE_BUILD_TYPE=${build_type^^}"
fi

# set compiler
if [ -z "$compiler" ];then
   cmake_compiler=""
else
   cmake_comiler=" -DCMAKE_CXX_COMPILER_ID=${compiler}"
fi

# set INSTALL and BUILD DIR (neccesary for building)
if [ -z "${SYSTEMNAME}" ]; then export SYSTEMNAME=$(hostname); fi

if [ -z "${build_dir}" ]; then
  cmake_build_dir="${cmake_tsmp2_dir}/bld/${SYSTEMNAME^^}_${model_id}" 
else
  cmake_build_dir="${build_dir}"
fi # build_dir

if [ -z "${install_dir}" ]; then
  cmake_install_dir="-DCMAKE_INSTALL_PREFIX=${cmake_tsmp2_dir}/bin/${SYSTEMNAME^^}_${model_id}"
else
  cmake_install_dir="-DCMAKE_INSTALL_PREFIX=${install_dir}"
fi # install_dir

if [ -z "${verbose_makefile}" ]; then
  cmake_verbose_makefile="" # equivalent to "-DCMAKE_VERBOSE_MAKEFILE=OFF"
else
  cmake_verbose_makefile="-DCMAKE_VERBOSE_MAKEFILE=ON"
fi # Makefile verbosity

build_log="$(dirname ${cmake_build_dir})/${model_id}_$(date +%Y-%m-%d_%H-%M).log"

## source environment if on JSC or env file is provided
if [[ -z "${tsmp2_env}" && ($SYSTEMNAME = "jurecadc" || $SYSTEMNAME = "juwels" || $SYSTEMNAME = "jusuf") ]]; then
  tsmp2_env="${cmake_tsmp2_dir}/env/jsc.2024_Intel.sh"
fi
if [ -n "${tsmp2_env}" ]; then
  message "Sourcing environment..."
  tsmp2_env="$(realpath "${tsmp2_env}")"
  source "$tsmp2_env"
fi

## CMAKE config
# rm -rf ${cmake_build_dir}
mkdir -p ${cmake_build_dir} $( echo "${cmake_install_dir}" |cut -d\= -f2)
message "===================="
message "== TSMP2 settings =="
message "===================="
message "MODEL_ID: $model_id"
message "TSMP2_DIR: $cmake_tsmp2_dir"
message "TSMP2_ENV: $tsmp2_env"
message "BUILD_DIR: $cmake_build_dir"
message "INSTALL_DIR: $( echo "${cmake_install_dir}" |cut -d\= -f2)"
message "CMAKE command:"
message "cmake -S ${cmake_tsmp2_dir} -B ${cmake_build_dir}  ${cmake_build_type} ${cmake_comp_str}  ${cmake_compsrc_str} ${cmake_compiler} ${cmake_install_dir} ${cmake_verbose_makefile} |& tee ${build_log} "
message "== CMAKE GENERATE PROJECT start"

cmake -S ${cmake_tsmp2_dir} -B ${cmake_build_dir} \
      ${cmake_build_type} \
      ${cmake_comp_str} \
      ${cmake_compsrc_str} \
      ${cmake_compiler} ${cmake_install_dir} \
      ${cmake_verbose_makefile} \
      |& tee ${build_log}

message "== CMAKE GENERATE PROJECT finished"

## Build and install

message "CMAKE build:"
message "cmake --build ${cmake_build_dir} |& tee -a $build_log"
message "== CMAKE BUILD start"
cmake --build ${cmake_build_dir} |& tee -a $build_log
message "== CMAKE BUILD finished"

message "CMAKE install:"
message "cmake --install ${cmake_build_dir} |& tee -a $build_log"
message "== CMAKE INSTALL start"
cmake --install ${cmake_build_dir} |& tee -a $build_log
message "== CMAKE INSTALL finished"

## Copy log and environment
message "Copying log and environment to install_dir..."
cp ${tsmp2_env} $( echo "${cmake_install_dir}" |cut -d\= -f2)
cp ${build_log} $( echo "${cmake_install_dir}" |cut -d\= -f2)

## message
message "Log can be found in: ${build_log}"
message "Model environment used: ${tsmp2_env}"
message "Model binaries can be found in: $( echo "${cmake_install_dir}" |cut -d\= -f2)"