Requirements

The following requirements ensure CLEO’s build, compilation and execution on DKRZ’s Levante HPC. If they do not work, please contact us or open a new issue on our GitHub repository.

Of course other architectures, other compilers, versions etc. are possible, but we leave this for you to discover.

The full list of packages CLEO uses for builds using the intel or gcc compiler on Levante can be found in our levante packages script and similarly for JUWELS in our juwels packages script

Compilers

A C++ compiler with the C++20 standard library and MPI is the absolute minimum.

On Levante you can use the latest MPI compiler wrappers for the gcc or intel compilers. At the time of writing for gcc 11.2.0, these are:

$ module load gcc/11.2.0-gcc-11.2.0 openmpi/4.1.2-gcc-11.2.0

To compile with C++ and CUDA, use Levante’s nvhpc compilers too, e.g.

$ module load gcc/11.2.0-gcc-11.2.0 openmpi/4.1.2-gcc-11.2.0
$ spack load cuda@12.2.0%gcc@=11.2.0

(Note you still need to use the gcc openmpi library as opposed to the cuda (nvhpc) ones because CLEO uses gcc not nvhpc where this is relevant).

CMake

CMake minimum version 3.18.0.

On Levante it’s best to use version 3.26.3 which can be loaded e.g. for gcc 11.2.0 via:

$ cmake@3.26.3%gcc@=11.2.0/fuvwuhz

YAC

YAC is one of the external libraries which CLEO requires for its configuration library (for MPI domain decomposition with/without YAC) and in order to couple to dynamics via YAC.

YAC (and its YAXT dependency) need to be installed manually before you can build CLEO with them. Please refer to the instructions on how to do install YAC (and YAXT) in our external libraries page.

YAC also requires some additional MPI, NetCDF and yaml libraries alongside the compatible gcc/intel compiler. For example for gcc 11.2.0, you can load these on Levante via:

$ module load gcc/11.2.0-gcc-11.2.0 openmpi@4.1.2%gcc@11.2.0 netcdf-c/4.8.1-openmpi-4.1.2-gcc-11.2.0
$ spack load openblas@0.3.18%gcc@=11.2.0

When you want to run CLEO, you will also need to export the fyaml library and python bindings paths, e.g.

$ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/sw/spack-levante/libfyaml-0.7.12-fvbhgo/lib
$ export PYTHONPATH=${PYTHONPATH}:/your/path/to/yac/python/

Python

To use PySD you need Python minimum version 3.10.4. We advise you to create an environment using our envirnoment.yml file. This environment should automatically include all the additional packages you may require. If not, please contact us or open a new issue on our GitHub repository.

To use PySD and to run CLEO’s examples, particular Python packages are needed. These are included in our environment.yml file and are the following: matplotlib, numpy, scipy, xarray, zarr, and awkward. If there are other dependencies not listed here, you will have to install them too. We kindly ask that you also contact us or open a new issue on our GitHub repository to notify us.

You can install Python packages to an existing Conda (or Micromamba) environment via:

$ micromamba activate [your environment]
$ python -m pip install [package name(s)]