Example procedure for the full setup, build, and run procedure on a MacOS machine

[mkavulich]

As the UFS community adopts spack-stack as its supported method of maintaining libraries and other utilities needed by the Unified Forecast System and its various components, the Single Column Model is also making this transition. In the latest develop branch, and in the upcoming release, this will be the recommended way of installing the prerequisite libraries. While our documentation will be updated in the coming months as the next release approaches, I thought including an example of the step-by-step installation process on a specific machine would be helpful for reference.

Note that the SCM team does not support spack-stack installations; users seeking info or help about the spack-stack package should reference the spack-stack documentation, or the spack-stack GitHub Discussions page.

Installing spack-stack

cd your_experiment_dir
export TOP_DIR=`pwd`
mkdir spack_stack_1.6.0
cd spack_stack_1.6.0
git clone --recurse-submodules https://github.com/jcsda/spack-stack.git -b 1.6.0
cd spack-stack
source setup.sh
ulimit -S -s unlimited
spack stack create env --site macos.default --template ufs-weather-model --name SCM
cd envs/SCM
spack env activate -p .
export SPACK_SYSTEM_CONFIG_PATH="$PWD/site"
spack external find --scope system     --exclude bison --exclude openssl     --exclude python
spack external find --scope system libiconv
spack external find --scope system perl
spack external find --scope system wget

Note that on this machine, the needed prerequisites were installed using Homebrew. If you installed them in a different way you may need to modify the following two commands.

PATH="$HOMEBREW_ROOT/opt/curl/bin:$PATH"      spack external find --scope system curl
PATH="$HOMEBREW_ROOT/opt/qt5/bin:$PATH"     spack external find --scope system qt
spack config --scope system add packages:pkg-config:buildable:false
spack compiler find --scope system
unset SPACK_SYSTEM_CONFIG_PATH
spack config add "packages:all:compiler:[[email protected]]"
spack config add "packages:all:providers:mpi:[[email protected]]"
spack concretize 2>&1 | tee log.concretize
../../util/show_duplicate_packages.py -d log.concretize
spack install --verbose --fail-fast 2>&1 | tee log.install
spack module lmod refresh
spack stack setup-meta-modules

Note: the "install" step may take several hours depending on your system configuration and internet speeds.

Building the CCPP SCM

The variable SPACK_STACK_DIR must be set in order for the macos module to load correctly.

export SPACK_STACK_DIR=${TOP_DIR}/spack_stack_1.6.0/spack-stack
source $HOMEBREW_ROOT/opt/lmod/init/profile
module use ${SPACK_STACK_DIR}/envs/SCM/install/modulefiles/Core
git clone --recursive [email protected]:mkavulich/ccpp-scm -b feature/macos_and_docker_build
cd ccpp-scm/scm
module use etc/modules/
module load macos_clang
mkdir bin && cd bin
cmake -DCCPP_SUITES=ALL ../src 2>&1 | tee log.cmake
make -j4 2>&1 | tee log.make

Running the CCPP SCM

Download the necessary runtime data files, then run all the provided example cases.

cd ../../
./contrib/get_all_static_data.sh
./contrib/get_thompson_tables.sh
cd scm/src/
./run_scm.py -f ../../test/rt_test_cases.py --runtime_mult 0.1