Add v1 data (#59)

* Add v1 data

* Updates on Perlmutter

* Address comments

* Address further comments

* Fix documentation

Author: forsyth2

docs/source/index.rst

@@ -15,6 +15,7 @@ simulations.
    :maxdepth: 2
    :caption: Contents:
 
+   v1/index
    v2/index
    v2.1/index
    SCREAMv0/index

docs/source/v1/WaterCycle/index.rst

@@ -0,0 +1,83 @@
+E3SMv1 (Water Cycle)
+====================
+
+The `E3SM version 1 water cycle simulation campaign <https://e3sm.org/research/water-cycle/v1-water-cycle/>`_ includes standard set of 
+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 
+in `Scientifically Validated Configurations <https://e3sm.org/model/scientifically-validated-configurations/>`_.
+
+For more details, 
+refer to `Coupled E3SM v1 Model Overview <https://e3sm.org/?p=5470>`_ or to the reference papers:
+
+* *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>`_
+
+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 ensemble members
+
+* AMIP
+
+  * amip – atmosphere only AMIP simulation 1870-2014 (145 years), 3 ensemble members
+  * amip_1850_allF – atmosphere only AMIP with all forcings held at 1850 values,  1870-2014 (145 years), 3 ensemble members
+  * amip_1850_aeroF – atmosphere only AMIP with all aerosol forcings held at 1850 values, 1870-2014 (145 years), 3 ensemble members
+
+* DAMIP
+
+  * damip_hist-GHG – greenhouse gases only, 3 ensemble members
+
+* Projection
+
+  * ssp5-8.5 – future projection, 5 ensemble members
+  * damip_ssp5-8.5-GHG – future projection with greenhouse gases only, 3 ensemble members
+
+For high-resolution:
+
+* Control Runs
+
+  * A_WCYCL1950S_CMIP6_HR.ne120_oRRS18v3_ICG -- 4 ensemble members
+
+* Transient Production Runs
+
+  * A_WCYCL20TRS_CMIP6_HR.ne120_oRRS18v3_ICG -- 2 ensemble members
+
+* Additional Simulations
+
+  * A_WCYCL1950S_CMIP6_LRtunedHR.ne30_oECv3_ICG – LR tuned HR control run, 1 ensemble member
+  * A_WCYCL20TRS_CMIP6_LRtunedHR.ne30_oECv3_ICG – LR tuned HR transient production run, 1 ensemble member
+  * F2010-CMIP6-HR – 3 ensemble members
+  * F2010C5-CMIP6 – 5 ensemble members. "nudgeUV" refers to U and V wind directions.
+  * F2010LRtunedHR – 4 ensemble members
+  * A_WCYCLSSP585_CMIP6_HR – future projection, 1 ensemble member
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   simulation_data/index
+   reproducing_simulations/index

docs/source/v1/WaterCycle/simulation_data/index.rst

@@ -0,0 +1,63 @@
+***************
+Simulation Data 
+***************
+
+The E3SMv1 simulation data is available on **NERSC HPSS**.
+
+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 **cam.h0** (monthly atmosphere output files) between **years 0030 and 0049** for the 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 "*.cam.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.
+
+Some 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/>`_. If a script is not collected here, you can try looking for the provenance run script with:
+  ::
+
+   zstash extract --hpss=/home/projects/e3sm/www/WaterCycle/E3SMv1/<LR or HR>/<simulation_name>/ case_scripts/run_script_provenance/*
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   simulation_table