General quick guide for running e3sm_diags v2

Warning

As of v2.6.0, e3sm_diags should be used as the module name instead of acme_diags. Instances of acme_diags in the Python import statements should be replaced accordingly.

1. Installation

We will use the e3sm_unifed environment to install. For the latest stable release or if you don’t have access to e3sm analysis machines, please instead refer to Latest stable release.

Most of the E3SM analysis software is maintained with an Anaconda metapackage (E3SM unified environment). If you have an account on an E3SM supported machine (Acme1, Andes, Anvil, Chrysalis, Compy, Cooley, Cori), then to get all of the tools in the metapackage in your path, use the corresponding activation command below. (Change .sh to .csh for csh shells.)

Below, we also provide the paths for observational data needed by e3sm_diags (<obs_path>), and some sample model data for testing (<test_data_path>). Both <obs_path> and <test_data_path> have two subdirectories: /climatology and /time-series for climatology and time-series data respectively.

Also listed below are paths where the HTML files (<html_path>) must be located to be displayed at their corresponding web addresses (<web_address>). Note that only some machines (Acme1, Anvil, Chrysalis, Compy, Cori) have a web server.

Acme1

<activation_command>: source /usr/local/e3sm_unified/envs/load_latest_e3sm_unified_acme1.sh

<obs_path>: /p/user_pub/e3sm/e3sm_diags_data/obs_for_e3sm_diags

<test_data_path>: /p/user_pub/e3sm/e3sm_diags_data/test_model_data_for_acme_diags

<html_path>: /var/www/acme/acme-diags/<username>

<web_address>: https://acme-viewer.llnl.gov/<username>

Andes

<activation_path>: source /ccs/proj/cli900/sw/rhea/e3sm-unified/load_latest_e3sm_unified_andes.sh

<obs_path>:/ccs/proj/cli115/e3sm_diags_data/obs_for_e3sm_diags/

<test_data_path>:/ccs/proj/cli115/e3sm_diags_data/test_model_data_for_acme_diags/

Anvil

<activation_path>: source /lcrc/soft/climate/e3sm-unified/load_latest_e3sm_unified_anvil.sh

<obs_path>: /lcrc/soft/climate/e3sm_diags_data/obs_for_e3sm_diags/

<test_data_path>: /lcrc/soft/climate/e3sm_diags_data/test_model_data_for_acme_diags/

<html_path>: /lcrc/group/e3sm/public_html/diagnostic_output/<username>/

<web_address>: https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/<username>

Chrysalis

<activation_path>: source /lcrc/soft/climate/e3sm-unified/load_latest_e3sm_unified_chrysalis.sh

<obs_path>: /lcrc/soft/climate/e3sm_diags_data/obs_for_e3sm_diags/

<test_data_path>: /lcrc/soft/climate/e3sm_diags_data/test_model_data_for_acme_diags/

<html_path>: /lcrc/group/e3sm/public_html/diagnostic_output/<username>/

<web_address>: https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/<username>

Compy

<activation_path>: source /share/apps/E3SM/conda_envs/load_latest_e3sm_unified_compy.sh

<obs_path>: /compyfs/e3sm_diags_data/obs_for_e3sm_diags/

<test_data_path>: /compyfs/e3sm_diags_data/test_model_data_for_acme_diags/

<html_path>: /compyfs/www/<username>

<web_address>: https://compy-dtn.pnl.gov/<username>

Cooley

<activation_path>: source /lus/theta-fs0/projects/ccsm/acme/tools/e3sm-unified/load_latest_e3sm_unified_cooley.sh

<obs_path>:/lus/theta-fs0/projects/ClimateEnergy_3/e3sm_diags/obs_for_e3sm_diags/

<test_data_path>:/lus/theta-fs0/projects/ClimateEnergy_3/e3sm_diags/test_model_data_for_acme_diags/

Cori-Haswell

[Note: there is known issue with running e3sm_diags on KNL, so running on Haswell is recommended.]

<activation_path>: source /global/cfs/cdirs/e3sm/software/anaconda_envs/load_latest_e3sm_unified_cori-haswell.sh

<obs_path>: /global/cfs/cdirs/e3sm/e3sm_diags/obs_for_e3sm_diags/

<test_data_path>: /global/cfs/cdirs/e3sm/e3sm_diags/test_model_data_for_acme_diags/

<html_path>: /global/cfs/cdirs/e3sm/www/<username>

<web_address>: http://portal.nersc.gov/cfs/e3sm/<username>

2. Config and run

See Acme1, Compy, or Cori. If you are using Anvil, Cooley, or Rhea, then follow one of these guides, substituting the corresponding paths from above. Again, note that only some machines (Acme1, Anvil, Compy, Cori) have a web server.