ClimaCoupler.jl

Coupler Specific Shared Development

Documentation
Unit Tests

Provides coupled system time stepping control and support for mapping import and export boundary information between components.

Recommended Julia Version: Stable release v1.10.1. CI no longer tests earlier versions of Julia.

Start Up

Before starting Julia, ensure your environment is properly set up. This includes loading the correct Julia version (specified in the Project.toml file), modules and setting the correct environment variables.

Typically (e.g., when running on your local machine) the installation of the required module libraries and specification of environment variables should be automatically handled by the Julia package manager upon running ]instantiate and ]build in the Julia REPL, which reads the Project.toml file. Each experiment has its own Project.toml file and Manifest.toml file, which are used to specify the exact environment for the experiment. Once instantiated, the experiment run scripts should be able to run without any further environment setup (e.g., with julia --project --threads 8 experiments/<your_experiment>.jl).

For computationally intensive jobs, it is recommended to run the jobs on a cluster using MPI and/or GPU triggered by a SLURM job script. In this case, we need to load specific MPI and GPU compatible modules and set the correct environment variables. For an example of a SLURM job script, see test/mpi_tests/local_checks.sh.