CLIMA

Climate Machine

Documentation	Build Status

Some notes on using CLIMA

The following instructions to install and run the code assume that Julia version 1.0.1 or greater installed; GPU version requires version 1.2 or greater and an NVIDIA GPU.

The MPI.jl package that is used assumes that you have a working MPI installation

Setup with CPUs

julia --project=@. -e "using Pkg; Pkg.instantiate(); Pkg.API.precompile()"

You can test that things were installed properly with

julia --project=@. $CLIMA_HOME/test/runtests.jl

where $CLIMA_HOME is the path to the base CLIMA directory

Problems building MPI.jl

If you are having problems building MPI.jl then most likely you need to set the environment variable JULIA_MPI_PATH. Additionally, if your MPI is not installed in a single place, e.g., MPI from macports in OSX, you may need to set JULIA_MPI_INCLUDE_PATH and JULIA_MPI_LIBRARY_PATH; for macports installs of MPI these would be subdirectories in /opt/local/include and /opt/local/lib.

Setup with GPUs

julia --project=$CLIMA_HOME/env/gpu -e "using Pkg; Pkg.instantiate(); Pkg.API.precompile()"

where $CLIMA_HOME is the path to the base CLIMA directory

You can test that things were installed properly with

julia --project=$CLIMA_HOME/env/gpu $CLIMA_HOME/test/runtests.jl