E3SM Unified Environment

E3SM software tools are easily installed through a Conda install. To make sure all software programs are able to coexist together and work seamlessly, the E3SM project is maintaining a unified Anaconda environment, E3SM Unified, which includes modules needed by all E3SM developed tools. Once you install this environment, you will be able to run any of the supported tools.

Activating the latest version of the Conda environment

On a supercomputer

To get all of the tools in the metapackage installed, use one of the sets of commands below and the activation path from the table below.  All environments use Python 3.7.

  • Default (without conda-forge version of MPI) for bash or csh shells:
    source <activate_path>/load_latest_e3sm_unified.sh
      or
    source <activate_path>/load_latest_e3sm_unified.csh
  • conda-forge MPICH for bash or csh shells:
    source <activate_path>/load_latest_e3sm_unified_mpich.sh
      or
    source <activate_path>/load_latest_e3sm_unified_mpich.csh

 

Path to activation script: <activate_path>

  • ACME1 (LLNL) . – /usr/local/e3sm_unified/envs
  • Anvil/Blues (ANL) – /lcrc/soft/climate/e3sm-unified
  • Compy (PNNL) – /share/apps/E3SM/conda_envs
  • Cooley  (ALCF) – /lus/theta-fs0/projects/ccsm/acme/tools/e3sm-unified
  • Cori (NERSC) – /global/cfs/cdirs/e3sm/software/anaconda_envs
  • Rhea (OLCF) – /ccs/proj/cli900/sw/rhea/e3sm-unified

On a personal machine

To install your own version of the metapackage (typically on a machine not supported by E3SM), install Anaconda or Miniconda and then run the following:

  conda create -n e3sm-unified -c conda-forge -c e3sm -c cdat/label/v82 e3sm-unified mesalib

If you plan to use the CDAT package to make plots to the screen (using X11), just omit the mesalib package:

  conda create -n e3sm-unified-cdatx -c conda-forge -c e3sm -c cdat/label/v82 e3sm-unified

 

Activating older versions of the Conda environment

To activate a previous E3SM-Unified environment, run:

source <activate_path>/base/etc/profile.d/conda.sh
conda activate e3sm_unified_1.2.6
  • For csh and related shells, Replace “.sh” with “.csh”.
  • To see other available versions, including different Python versions and CDAT x-windows support, run
    conda env list

 

Documentation

Send this to a friend