Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ simulations.
:maxdepth: 2
:caption: Contents:

v1/index
v2/index
v2.1/index
SCREAMv0/index
Expand Down
72 changes: 72 additions & 0 deletions docs/source/v1/WaterCycle/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
E3SMv1 (Water Cycle)
====================

The `E3SM version 1 water cycle simulation campaign <https://e3sm.org/research/water-cycle/v1-water-cycle/>`_ includes standard set of
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"website is undergoing maintenance"

Coupled Model Intercomparison Project Phase 6 (`CMIP6 <https://www.geosci-model-dev.net/9/1937/2016/>`_)
Diagnosis, Evaluation, and Characterization of Klima (DECK) simulations.
These E3SM simulations at standard resolution have been completed and the data is publicly available.

Data Resolution:

The standard resolution configuration of E3SM v1.0 water cycle configuration has approximate horizontal resolution of
1 deg latitude by 1 deg longitude in atmosphere (110 km grid spacing),
with ocean and sea ice grid of 60 km in the mid-latitudes and 30 km at the equator and poles,
and river transport at 55 km horizontal resolution.
This model configuration is described in
`“v1 1 deg CMIP” <https://e3sm.org/model/scientifically-validated-configurations/v1-configurations/v1-1-deg-cmip6/?preview=true>`_ page
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"website is undergoing maintenance"

in `Scientifically Validated Configurations <https://e3sm.org/model/scientifically-validated-configurations/>`_.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"website is undergoing maintenance"


For more details,
refer to `Coupled E3SM v1 Model Overview <https://e3sm.org/?p=5470>`_ or to the reference papers:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"website is undergoing maintenance"


* *The DOE E3SM Coupled Model Version 1: Overview and Evaluation at Standard Resolution* `doi: 10.1029/2018MS001603 <https://doi.org/10.1029/2018MS001603>_`
* *Description of historical and future projection simulations by the global coupled E3SMv1.0 model as used in CMIP6* `doi:10.5194/gmd-15-3941-2022 <https://doi.org/10.5194/gmd-15-3941-2022>_`
* *The DOE E3SM Coupled Model Version 1: Description and Results at High Resolution* `doi:10.1029/2019MS001870 <https://doi.org/10.1029/2019MS001870>`_
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get links to show up correctly


Experiments:

The datasets include the following experiments.

For low-resolution:

* DECK

* piControl – Pre-industrial control (piControl) simulation (500 years)
* 1pctCO2 – Prescribed 1% / year CO2 increase (1pctCO2) simulation (150 years)
* abrupt-4xCO2 – Abrupt CO2 quadrupling (abrupt-4xCO2) simulation (150 years)
* abrupt-4xCO2-ext300yrs – Abrupt CO2 quadrupling (abrupt-4xCO2) simulation (140-300 years)

* Historical

* historical – Historical simulations 1850-2014 (165 years) 5 ensembles

* AMIP

* amip – atmosphere only AMIP simulation 1870-2014 (145 years) 3 ensembles
* amip_1850_allF – atmosphere only AMIP with all forcings held at 1850 values, 1870-2014 (145 years) 3 ensembles
* amip_1850_aeroF – atmosphere only AMIP with all aerosol forcings held at 1850 values, 1870-2014 (145 years) 3 ensembles

* DAMIP

* damip_hist-GHG 3 ensembles
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GHG only


* Projection

* ssp5-8.5 5 ensembles
* damip_ssp5-8.5-GHG 3 ensembles
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

future projection
future projection with GHG only

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ensemble members" not ensembles


For high-resolution:


TODO: Find remaining original run scripts
TODO: Add descriptions for added LR simulations above
TODO: Correctly categorize HR simulations
TODO: Determine correct CMIP/Native Links
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining TODOs

Copy link
Collaborator Author

@forsyth2 forsyth2 Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also change group to e3sm in /home/projects/e3sm/www/WaterCycle/E3SMv1/. If @ndkeen can move the remaining simulation then we'll also need the e3sm group for that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running chgrp -R e3sm /home/projects/e3sm/www/WaterCycle/E3SMv1/

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guys, stop tagging me, pls. :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about that! Thanks @rljacob for updating the references to the correct tag!



.. toctree::
:maxdepth: 2
:caption: Contents:

simulation_data/index
reproducing_simulations/index
62 changes: 62 additions & 0 deletions docs/source/v1/WaterCycle/simulation_data/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
***************
Simulation Data
***************

The E3SMv1 simulation data is available on **ESGF** and **NERSC HPSS**.

The preferred retrieval method is **ESGF**. Native output is available at `ESGF <https://esgf-node.llnl.gov/search/e3sm/?model_version=1_0>`_, and a subset of the data is reformatted to conform to CMIP conventions and submmited to the CMIP6 ESGF archive (ESGF links are provided in the table below for published data).

Additionally, all native model output data has also been archived on **NERSC HPSS** using `zstash <https://e3sm-project.github.io/zstash>`_.

**If you have an account on NERSC**, you can retrieve the data locally or remotely using Globus.

To download simulation data locally on a NERSC machine: ::

zstash extract --hpss=<HPSS path in table>

To download simulation data remotely using the zstash Globus interface: ::

zstash extract --hpss=globus://nersc/<HPSS path in table>

or ::

zstash extract --hpss=globus://9cd89cfd-6d04-11e5-ba46-22000b92c6ec/<HPSS path below>

Note that the data management tool `zstash <https://github.com/E3SM-Project/zstash>`_ is available from the `E3SM-Unified <https://github.com/E3SM-Project/e3sm-unified>`_ conda environment. An example of retrieving all **eam.h0** (monthly atmosphere output files) between **years 0030 and 0049** for the v2.LR.piControl simulation at NERSC locally is demonstrated as below in two steps:

1. To activate E3SM-Unified environment by:
::

source /global/common/software/e3sm/anaconda_envs/load_latest_e3sm_unified_pm-cpu.sh

2. To retrieve files with zstash command:
::

zstash extract --hpss=/home/projects/e3sm/www/WaterCycle/E3SMv1/LR/20180129.DECKv1b_piControl.ne30_oEC.edison "*.elm.h0.00[3-4]?-??.nc"


For more information, refer to `zstash usage <https://e3sm-project.github.io/zstash/_build/html/master/usage.html#extract>`_.


**If you do not have access to NERSC**, you can download simulation data directly through the NERSC HPSS
`web interface <https://portal.nersc.gov/archive/home/projects/e3sm/www/WaterCycle/E3SMv1>`_.
Note that this will be slow and inefficient since you'll have to download the tar files.

**v1.LR** simulations data has been archived on NERSC HPSS under: ::

/home/projects/e3sm/www/WaterCycle/E3SMv1/LR

and **v1.HR** simulations data under: ::

/home/projects/e3sm/www/WaterCycle/E3SMv1/HR


Scripts are not available to reproduce v1 simulations.

Original run scripts (the scripts that were originally used to create the simulations) have been archived here `here <https://github.com/E3SM-Project/e3sm_data_docs/tree/main/run_scripts/v1/original/>`_. These latter scripts are provided for reference only.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming we should add original scripts, but I can't seem to find them.

Example:

> zstash ls --hpss=/home/projects/e3sm/www/WaterCycle/E3SMv1/HR/cori-knl.20190214_maint-1.0.F2010C5-CMIP6-HR.ARE.nudgeUV.1850aero.ne120_oRRS18v3 *.sh
For help, please see https://e3sm-project.github.io/zstash. Ask questions at https://github.com/E3SM-Project/zstash/discussions/categories/q-a.
build/ice/source/core_atmosphere/physics/checkout_data_files.sh
build/ice/source/core_ocean/get_cvmix.sh
build/ocn/source/core_atmosphere/physics/checkout_data_files.sh
build/ocn/source/core_ocean/get_BGC.sh
build/ocn/source/core_ocean/get_cvmix.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/Bryan-Lewis/BL_test.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/build.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/check_inputdata.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/environ.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/parse_inputs.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/run.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/common/usage.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/double_diff/double_diff-test.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/kpp/kpp-test.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/shear/shear-test.sh
build/ocn/source/core_ocean/.cvmix_all/reg_tests/tidal-Simmons/Simmons-test.sh
case_scripts/.env_mach_specific.sh
test01/case_scripts/.env_mach_specific.sh

None of these look like a production run script...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we list the scripts on Confluence?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I finally found the v2 simulation Confluence pages, e.g., v2.LR.piControl but I'm not seeing clear equivalents anywhere from v1. In any case, that page links to a run script, and from there it looks like there may be some v1 run scripts.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run scripts might be in provenance. Put in the index.rst search for case_scripts/run_script_provenance/, they can use zstash extract to get those files. We don't have to worry about adding run scripts to this repo.


.. toctree::
:maxdepth: 2
:caption: Contents:

simulation_table
Loading