Skip to content

Commit aa27ca8

Browse files
Update documentation
1 parent d10065e commit aa27ca8

File tree

9 files changed

+72
-51
lines changed

9 files changed

+72
-51
lines changed

_build/html/SCREAMv0/DYAMOND2/index.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ <h1>SCREAMv0 DYAMOND2<a class="headerlink" href="#screamv0-dyamond2" title="Perm
9090
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
9191
<ul>
9292
<li class="toctree-l1"><a class="reference internal" href="simulation_data/index.html">Simulation Data</a><ul>
93-
<li class="toctree-l2"><a class="reference internal" href="simulation_data/simulation_table.html">SCREAMv0 DYAMOND2 (2021) simulation table</a></li>
93+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#instructions">Instructions</a></li>
94+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#original-run-scripts">Original Run Scripts</a></li>
95+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#table-of-simulation-data">Table of simulation data</a></li>
9496
</ul>
9597
</li>
9698
</ul>

_build/html/SCREAMv0/DYAMOND2/simulation_data/index.html

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@
4646
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">SCREAMv0</a><ul class="current">
4747
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">SCREAMv0 DYAMOND2</a><ul class="current">
4848
<li class="toctree-l3 current"><a class="current reference internal" href="#">Simulation Data</a><ul>
49-
<li class="toctree-l4"><a class="reference internal" href="simulation_table.html">SCREAMv0 DYAMOND2 (2021) simulation table</a></li>
49+
<li class="toctree-l4"><a class="reference internal" href="#instructions">Instructions</a></li>
50+
<li class="toctree-l4"><a class="reference internal" href="#original-run-scripts">Original Run Scripts</a></li>
51+
<li class="toctree-l4"><a class="reference internal" href="#table-of-simulation-data">Table of simulation data</a></li>
5052
</ul>
5153
</li>
5254
</ul>
@@ -84,19 +86,27 @@
8486

8587
<section id="simulation-data">
8688
<h1>Simulation Data<a class="headerlink" href="#simulation-data" title="Permalink to this heading"></a></h1>
87-
<p>The SCREAMv0 simulation data is available on <strong>NERSC HPSS</strong>.</p>
88-
<p><strong>If you have an account on NERSC</strong>, you can retrieve the data locally or remotely using Globus.</p>
89-
<p>To download simulation data locally on a NERSC machine, refer to NERSC’s documentation <a class="reference external" href="https://docs.nersc.gov/filesystems/archive/#hsi-commands">here</a>.</p>
89+
<section id="instructions">
90+
<h2>Instructions<a class="headerlink" href="#instructions" title="Permalink to this heading"></a></h2>
91+
<p>The SCREAMv0 simulation data are available on <strong>NERSC HPSS</strong>.</p>
92+
<p><strong>If you have an account on NERSC</strong>, you can retrieve the data locally or remotely using Globus. To download simulation data locally on a NERSC machine, refer to NERSC’s documentation <a class="reference external" href="https://docs.nersc.gov/filesystems/archive/#hsi-commands">here</a>.</p>
9093
<p><strong>If you do not have access to NERSC</strong>, you can download simulation data directly through the NERSC HPSS
9194
<a class="reference external" href="https://portal.nersc.gov/archive/home/t/terai/www/SCREAM/SCREAMv0.SCREAM-DY2.ne1024pg2.20201127">web interface</a>.
9295
Note that this will be slow given the large file sizes.</p>
96+
</section>
97+
<section id="original-run-scripts">
98+
<h2>Original Run Scripts<a class="headerlink" href="#original-run-scripts" title="Permalink to this heading"></a></h2>
9399
<p>Scripts originally used to run SCREAMv0 DYAMOND2 simulations are available <a class="reference external" href="https://github.com/E3SM-Project/e3sm_data_docs/tree/main/run_scripts/SCREAMv0/original/">here</a>.</p>
100+
<p><strong>Warning, these will not run out-of-the-box</strong>. They are provided to give guidance for setting up a similar run.</p>
101+
</section>
102+
<section id="table-of-simulation-data">
103+
<h2>Table of simulation data<a class="headerlink" href="#table-of-simulation-data" title="Permalink to this heading"></a></h2>
94104
<div class="toctree-wrapper compound">
95-
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
96105
<ul>
97106
<li class="toctree-l1"><a class="reference internal" href="simulation_table.html">SCREAMv0 DYAMOND2 (2021) simulation table</a></li>
98107
</ul>
99108
</div>
109+
</section>
100110
</section>
101111

102112

_build/html/SCREAMv0/DYAMOND2/simulation_data/simulation_table.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@
4646
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">SCREAMv0</a><ul class="current">
4747
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">SCREAMv0 DYAMOND2</a><ul class="current">
4848
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Simulation Data</a><ul class="current">
49-
<li class="toctree-l4 current"><a class="current reference internal" href="#">SCREAMv0 DYAMOND2 (2021) simulation table</a></li>
49+
<li class="toctree-l4"><a class="reference internal" href="index.html#instructions">Instructions</a></li>
50+
<li class="toctree-l4"><a class="reference internal" href="index.html#original-run-scripts">Original Run Scripts</a></li>
51+
<li class="toctree-l4 current"><a class="reference internal" href="index.html#table-of-simulation-data">Table of simulation data</a></li>
5052
</ul>
5153
</li>
5254
</ul>

_build/html/SCREAMv1/FourSeasons/index.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ <h1>SCREAMv1 Four Seasons<a class="headerlink" href="#screamv1-four-seasons" tit
9191
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
9292
<ul>
9393
<li class="toctree-l1"><a class="reference internal" href="simulation_data/index.html">Simulation Data</a><ul>
94-
<li class="toctree-l2"><a class="reference internal" href="simulation_data/simulation_table.html">SCREAMv1 Four-Seasons (2024) simulation table</a></li>
94+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#instructions">Instructions</a></li>
95+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#original-run-scripts">Original Run Scripts</a></li>
96+
<li class="toctree-l2"><a class="reference internal" href="simulation_data/index.html#table-of-simulation-data">Table of simulation data</a></li>
9597
</ul>
9698
</li>
9799
</ul>

_build/html/SCREAMv1/FourSeasons/simulation_data/index.html

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@
4747
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">SCREAMv1</a><ul class="current">
4848
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">SCREAMv1 Four Seasons</a><ul class="current">
4949
<li class="toctree-l3 current"><a class="current reference internal" href="#">Simulation Data</a><ul>
50-
<li class="toctree-l4"><a class="reference internal" href="simulation_table.html">SCREAMv1 Four-Seasons (2024) simulation table</a></li>
50+
<li class="toctree-l4"><a class="reference internal" href="#instructions">Instructions</a></li>
51+
<li class="toctree-l4"><a class="reference internal" href="#original-run-scripts">Original Run Scripts</a></li>
52+
<li class="toctree-l4"><a class="reference internal" href="#table-of-simulation-data">Table of simulation data</a></li>
5153
</ul>
5254
</li>
5355
</ul>
@@ -84,32 +86,27 @@
8486

8587
<section id="simulation-data">
8688
<h1>Simulation Data<a class="headerlink" href="#simulation-data" title="Permalink to this heading"></a></h1>
87-
<p>The SCREAMv1 FourSeasons simulation data is available on <strong>NERSC HPSS</strong>.</p>
88-
<p><strong>If you have an account on NERSC</strong>, you can retrieve the data locally or remotely using Globus.</p>
89-
<p>To download simulation data locally on a NERSC machine:</p>
90-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">zstash</span> <span class="n">extract</span> <span class="o">--</span><span class="n">hpss</span><span class="o">=&lt;</span><span class="n">HPSS</span> <span class="n">path</span> <span class="n">below</span><span class="o">&gt;</span>
91-
</pre></div>
92-
</div>
93-
<p>To download simulation data remotely using the zstash Globus interface:</p>
94-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">zstash</span> <span class="n">extract</span> <span class="o">--</span><span class="n">hpss</span><span class="o">=</span><span class="n">globus</span><span class="p">:</span><span class="o">//</span><span class="n">nersc</span><span class="o">/&lt;</span><span class="n">HPSS</span> <span class="n">path</span> <span class="n">below</span><span class="o">&gt;</span>
95-
</pre></div>
96-
</div>
97-
<p>or</p>
98-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">zstash</span> <span class="n">extract</span> <span class="o">--</span><span class="n">hpss</span><span class="o">=</span><span class="n">globus</span><span class="p">:</span><span class="o">//</span><span class="mi">9</span><span class="n">cd89cfd</span><span class="o">-</span><span class="mi">6</span><span class="n">d04</span><span class="o">-</span><span class="mf">11e5</span><span class="o">-</span><span class="n">ba46</span><span class="o">-</span><span class="mi">22000</span><span class="n">b92c6ec</span><span class="o">/&lt;</span><span class="n">HPSS</span> <span class="n">path</span> <span class="n">below</span><span class="o">&gt;</span>
99-
</pre></div>
100-
</div>
101-
<p>Note that the data management tool <a class="reference external" href="https://github.com/E3SM-Project/zstash">zstash</a> is available from the <a class="reference external" href="https://github.com/E3SM-Project/e3sm-unified">E3SM-Unified</a> conda environment.</p>
102-
<p>For more information, refer to <a class="reference external" href="https://e3sm-project.github.io/zstash/_build/html/master/usage.html#extract">zstash usage</a>.</p>
89+
<section id="instructions">
90+
<h2>Instructions<a class="headerlink" href="#instructions" title="Permalink to this heading"></a></h2>
91+
<p>The SCREAMv1 FourSeasons simulation data are available on <strong>NERSC HPSS</strong>.</p>
92+
<p><strong>If you have an account on NERSC</strong>, you can retrieve the data locally or remotely using Globus. To download simulation data locally on a NERSC machine, refer to NERSC’s documentation <a class="reference external" href="https://docs.nersc.gov/filesystems/archive/#hsi-commands">here</a>.</p>
10393
<p><strong>If you do not have access to NERSC</strong>, you can download simulation data directly through the NERSC HPSS
10494
<a class="reference external" href="https://portal.nersc.gov/archive/home/a/adonahue/www/">web interface</a>.
105-
Note that this will be slow and inefficient since you’ll have to download the individual files.</p>
95+
Note that this will be slow given the large file sizes.</p>
96+
</section>
97+
<section id="original-run-scripts">
98+
<h2>Original Run Scripts<a class="headerlink" href="#original-run-scripts" title="Permalink to this heading"></a></h2>
10699
<p>Scripts originally used to run SCREAMv1 FourSeasons simulations are available <a class="reference external" href="https://github.com/E3SM-Project/e3sm_data_docs/tree/main/run_scripts/SCREAMv1/original/">here</a>.</p>
100+
<p><strong>Warning, these will not run out-of-the-box</strong>. They are provided to give guidance for setting up a similar run.</p>
101+
</section>
102+
<section id="table-of-simulation-data">
103+
<h2>Table of simulation data<a class="headerlink" href="#table-of-simulation-data" title="Permalink to this heading"></a></h2>
107104
<div class="toctree-wrapper compound">
108-
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
109105
<ul>
110106
<li class="toctree-l1"><a class="reference internal" href="simulation_table.html">SCREAMv1 Four-Seasons (2024) simulation table</a></li>
111107
</ul>
112108
</div>
109+
</section>
113110
</section>
114111

115112

_build/html/SCREAMv1/FourSeasons/simulation_data/simulation_table.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@
4646
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">SCREAMv1</a><ul class="current">
4747
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">SCREAMv1 Four Seasons</a><ul class="current">
4848
<li class="toctree-l3 current"><a class="reference internal" href="index.html">Simulation Data</a><ul class="current">
49-
<li class="toctree-l4 current"><a class="current reference internal" href="#">SCREAMv1 Four-Seasons (2024) simulation table</a></li>
49+
<li class="toctree-l4"><a class="reference internal" href="index.html#instructions">Instructions</a></li>
50+
<li class="toctree-l4"><a class="reference internal" href="index.html#original-run-scripts">Original Run Scripts</a></li>
51+
<li class="toctree-l4 current"><a class="reference internal" href="index.html#table-of-simulation-data">Table of simulation data</a></li>
5052
</ul>
5153
</li>
5254
</ul>

_build/html/_sources/SCREAMv0/DYAMOND2/simulation_data/index.rst.txt

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22
Simulation Data
33
***************
44

5-
The SCREAMv0 simulation data is available on **NERSC HPSS**.
65

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

9-
To download simulation data locally on a NERSC machine, refer to NERSC's documentation `here <https://docs.nersc.gov/filesystems/archive/#hsi-commands>`_.
7+
Instructions
8+
************
9+
10+
The SCREAMv0 simulation data are available on **NERSC HPSS**.
11+
12+
**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, refer to NERSC's documentation `here <https://docs.nersc.gov/filesystems/archive/#hsi-commands>`_.
1013

1114
**If you do not have access to NERSC**, you can download simulation data directly through the NERSC HPSS
1215
`web interface <https://portal.nersc.gov/archive/home/t/terai/www/SCREAM/SCREAMv0.SCREAM-DY2.ne1024pg2.20201127>`_.
1316
Note that this will be slow given the large file sizes.
1417

18+
Original Run Scripts
19+
*********************
20+
1521
Scripts originally used to run SCREAMv0 DYAMOND2 simulations are available `here <https://github.com/E3SM-Project/e3sm_data_docs/tree/main/run_scripts/SCREAMv0/original/>`_.
1622

23+
**Warning, these will not run out-of-the-box**. They are provided to give guidance for setting up a similar run.
24+
25+
Table of simulation data
26+
************************
27+
1728
.. toctree::
1829
:maxdepth: 2
19-
:caption: Contents:
2030

21-
simulation_table
31+
simulation_table

_build/html/_sources/SCREAMv1/FourSeasons/simulation_data/index.rst.txt

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,30 @@
22
Simulation Data
33
***************
44

5-
The SCREAMv1 FourSeasons simulation data is available on **NERSC HPSS**.
65

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

9-
To download simulation data locally on a NERSC machine: ::
7+
Instructions
8+
************
109

11-
zstash extract --hpss=<HPSS path below>
10+
The SCREAMv1 FourSeasons simulation data are available on **NERSC HPSS**.
1211

13-
To download simulation data remotely using the zstash Globus interface: ::
14-
15-
zstash extract --hpss=globus://nersc/<HPSS path below>
16-
17-
or ::
18-
19-
zstash extract --hpss=globus://9cd89cfd-6d04-11e5-ba46-22000b92c6ec/<HPSS path below>
20-
21-
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.
22-
23-
For more information, refer to `zstash usage <https://e3sm-project.github.io/zstash/_build/html/master/usage.html#extract>`_.
12+
**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, refer to NERSC's documentation `here <https://docs.nersc.gov/filesystems/archive/#hsi-commands>`_.
2413

2514
**If you do not have access to NERSC**, you can download simulation data directly through the NERSC HPSS
2615
`web interface <https://portal.nersc.gov/archive/home/a/adonahue/www/>`_.
27-
Note that this will be slow and inefficient since you'll have to download the individual files.
16+
Note that this will be slow given the large file sizes.
17+
18+
Original Run Scripts
19+
*********************
2820

2921
Scripts originally used to run SCREAMv1 FourSeasons simulations are available `here <https://github.com/E3SM-Project/e3sm_data_docs/tree/main/run_scripts/SCREAMv1/original/>`_.
3022

23+
**Warning, these will not run out-of-the-box**. They are provided to give guidance for setting up a similar run.
24+
25+
Table of simulation data
26+
************************
27+
3128
.. toctree::
3229
:maxdepth: 2
33-
:caption: Contents:
3430

3531
simulation_table

0 commit comments

Comments
 (0)