Update docs

LinkedEarth · Feb 5, 2024 · caa7598 · caa7598
1 parent ea32e2f
commit caa7598
Show file tree

Hide file tree

Showing 130 changed files with 51,049 additions and 1,958 deletions.
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_11_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_11_1.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_12_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_12_1.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_14_2.png b/docs/_images/notebooks_eg24-Fig1_motivation_14_2.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_17_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_17_1.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_3_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_3_1.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_5_0.png b/docs/_images/notebooks_eg24-Fig1_motivation_5_0.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_6_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_6_1.png
diff --git a/docs/_images/notebooks_eg24-Fig1_motivation_8_1.png b/docs/_images/notebooks_eg24-Fig1_motivation_8_1.png
diff --git a/docs/_images/notebooks_eg24-Fig2_naive_resampling_16_0.png b/docs/_images/notebooks_eg24-Fig2_naive_resampling_16_0.png
diff --git a/docs/_images/notebooks_eg24-Fig2_naive_resampling_2_1.png b/docs/_images/notebooks_eg24-Fig2_naive_resampling_2_1.png
diff --git a/docs/_images/notebooks_eg24-Fig2_naive_resampling_4_2.png b/docs/_images/notebooks_eg24-Fig2_naive_resampling_4_2.png
diff --git a/docs/_images/notebooks_eg24-Fig2_naive_resampling_6_1.png b/docs/_images/notebooks_eg24-Fig2_naive_resampling_6_1.png
diff --git a/docs/_images/notebooks_eg24-Fig3_4_LMRonline_10_0.png b/docs/_images/notebooks_eg24-Fig3_4_LMRonline_10_0.png
diff --git a/docs/_images/notebooks_eg24-Fig3_4_LMRonline_11_0.png b/docs/_images/notebooks_eg24-Fig3_4_LMRonline_11_0.png
diff --git a/docs/_images/notebooks_eg24-Fig3_4_LMRonline_15_1.png b/docs/_images/notebooks_eg24-Fig3_4_LMRonline_15_1.png
diff --git a/docs/_images/notebooks_eg24-Fig3_4_LMRonline_3_0.png b/docs/_images/notebooks_eg24-Fig3_4_LMRonline_3_0.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_11_0.png b/docs/_images/notebooks_eg24-Fig5_resampling_11_0.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_12_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_12_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_14_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_14_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_17_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_17_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_20_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_20_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_22_0.png b/docs/_images/notebooks_eg24-Fig5_resampling_22_0.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_22_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_22_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_24_0.png b/docs/_images/notebooks_eg24-Fig5_resampling_24_0.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_28_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_28_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_33_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_33_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_37_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_37_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_39_2.png b/docs/_images/notebooks_eg24-Fig5_resampling_39_2.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_3_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_3_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_40_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_40_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_45_2.png b/docs/_images/notebooks_eg24-Fig5_resampling_45_2.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_47_2.png b/docs/_images/notebooks_eg24-Fig5_resampling_47_2.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_50_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_50_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_53_2.png b/docs/_images/notebooks_eg24-Fig5_resampling_53_2.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_54_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_54_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_57_0.png b/docs/_images/notebooks_eg24-Fig5_resampling_57_0.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_5_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_5_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_7_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_7_1.png
diff --git a/docs/_images/notebooks_eg24-Fig5_resampling_9_1.png b/docs/_images/notebooks_eg24-Fig5_resampling_9_1.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_10_0.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_10_0.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_11_1.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_11_1.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_14_1.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_14_1.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_24_0.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_24_0.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_3_1.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_3_1.png
diff --git a/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_5_0.png b/docs/_images/notebooks_eg24-LMR_PMIP3_proximity_table_5_0.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_15_1.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_15_1.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_22_2.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_22_2.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_24_2.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_24_2.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_27_1.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_27_1.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_29_1.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_29_1.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_2_1.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_2_1.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_30_0.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_30_0.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_32_0.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_32_0.png
diff --git a/docs/_images/notebooks_eg24-compare_LMRvsB21_5_1.png b/docs/_images/notebooks_eg24-compare_LMRvsB21_5_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_13_2.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_13_2.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_16_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_16_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_18_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_18_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_25_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_25_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_28_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_28_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_6_0.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_6_0.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_6_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_6_1.png
diff --git a/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_8_1.png b/docs/_images/notebooks_eg24-compare_PAGES2k2019_recons_8_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_12_1.png b/docs/_images/notebooks_eg24-plume_distance_12_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_15_0.png b/docs/_images/notebooks_eg24-plume_distance_15_0.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_17_1.png b/docs/_images/notebooks_eg24-plume_distance_17_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_23_1.png b/docs/_images/notebooks_eg24-plume_distance_23_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_3_0.png b/docs/_images/notebooks_eg24-plume_distance_3_0.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_43_1.png b/docs/_images/notebooks_eg24-plume_distance_43_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_49_1.png b/docs/_images/notebooks_eg24-plume_distance_49_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_52_1.png b/docs/_images/notebooks_eg24-plume_distance_52_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_61_1.png b/docs/_images/notebooks_eg24-plume_distance_61_1.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_7_0.png b/docs/_images/notebooks_eg24-plume_distance_7_0.png
diff --git a/docs/_images/notebooks_eg24-plume_distance_8_1.png b/docs/_images/notebooks_eg24-plume_distance_8_1.png
diff --git a/docs/_sources/index.rst b/docs/_sources/index.rst
@@ -18,29 +18,29 @@ pens: utilities for comparing paleoclimate reconstruction ensembles
 
         Installation instructions.
 
-    .. grid-item-card::  Examples
+    .. grid-item-card::  Examples in Emile-Geay et al. (2024)
         :class-title: custom-title
         :class-body: custom-body
         :img-top: _static/examples.png
-        :link: ug-examples
+        :link: ug-eg24
         :link-type: doc
 
-        The examples in paper Emile-Geay et al. (2024).
+        Examples of the scientific use of the package, as introduced in Emile-Geay et al. (2024).
 
-    .. grid-item-card::  API
+    .. grid-item-card:: package API
         :class-title: custom-title
         :class-body: custom-body
         :img-top: _static/api.png
         :link: ug-api
         :link-type: doc
 
-        The essential API.
+        Application programming interface of the package, name the EnsembleTS class.
 
 .. toctree::
    :maxdepth: 2
    :hidden:
    :caption: User Guide
 
    ug-installation
-   ug-examples
-   ug-api
+   ug-eg24
+   ug-api
diff --git a/docsrc/notebooks/Fig1_motivation.ipynb → ...rces/notebooks/eg24-Fig1_motivation.ipynb b/docsrc/notebooks/Fig1_motivation.ipynb → ...rces/notebooks/eg24-Fig1_motivation.ipynb
diff --git a/docsrc/notebooks/Fig2_naive_resampling.ipynb → ...otebooks/eg24-Fig2_naive_resampling.ipynb b/docsrc/notebooks/Fig2_naive_resampling.ipynb → ...otebooks/eg24-Fig2_naive_resampling.ipynb
diff --git a/docsrc/notebooks/Fig3_4_LMRonline.ipynb → ...ces/notebooks/eg24-Fig3_4_LMRonline.ipynb b/docsrc/notebooks/Fig3_4_LMRonline.ipynb → ...ces/notebooks/eg24-Fig3_4_LMRonline.ipynb
diff --git a/docsrc/notebooks/Fig5_resampling.ipynb → ...rces/notebooks/eg24-Fig5_resampling.ipynb b/docsrc/notebooks/Fig5_resampling.ipynb → ...rces/notebooks/eg24-Fig5_resampling.ipynb
diff --git a/...notebooks/LMR_PMIP3_proximity_table.ipynb → ...ooks/eg24-LMR_PMIP3_proximity_table.ipynb b/...notebooks/LMR_PMIP3_proximity_table.ipynb → ...ooks/eg24-LMR_PMIP3_proximity_table.ipynb
diff --git a/docsrc/notebooks/compare_LMRvsB21.ipynb → ...ces/notebooks/eg24-compare_LMRvsB21.ipynb b/docsrc/notebooks/compare_LMRvsB21.ipynb → ...ces/notebooks/eg24-compare_LMRvsB21.ipynb
diff --git a/...otebooks/compare_PAGES2k2019_recons.ipynb → ...oks/eg24-compare_PAGES2k2019_recons.ipynb b/...otebooks/compare_PAGES2k2019_recons.ipynb → ...oks/eg24-compare_PAGES2k2019_recons.ipynb
diff --git a/docsrc/notebooks/plume_distance.ipynb → ...urces/notebooks/eg24-plume_distance.ipynb b/docsrc/notebooks/plume_distance.ipynb → ...urces/notebooks/eg24-plume_distance.ipynb
diff --git a/docs/_sources/notebooks/paper-fig-01.ipynb b/docs/_sources/notebooks/paper-fig-01.ipynb
diff --git a/docs/_sources/ug-eg24.rst b/docs/_sources/ug-eg24.rst
@@ -0,0 +1,16 @@
+
+Emile-Geay et al. (2024)
+========================
+This section shows the usage of `pens` as in the paper entitled *Using offline data assimilation to diagnose temporal variability in paleoclimate metrics* submitted to *Journal of Climate* (Emile-Geay et al., 2024).
+
+.. toctree::
+    :maxdepth: 1
+
+    notebooks/eg24-Fig1_motivation
+    notebooks/eg24-Fig2_naive_resampling
+    notebooks/eg24-Fig3_4_LMRonline
+    notebooks/eg24-Fig5_resampling
+    notebooks/eg24-plume_distance
+    notebooks/eg24-LMR_PMIP3_proximity_table
+    notebooks/eg24-compare_PAGES2k2019_recons
+    notebooks/eg24-compare_LMRvsB21
diff --git a/docs/_sources/ug-examples.rst b/docs/_sources/ug-examples.rst
diff --git a/docs/_sources/ug-installation.rst b/docs/_sources/ug-installation.rst
@@ -76,7 +76,7 @@ Once the above dependencies have been installed, simply
 
 .. code-block:: bash
 
-    pip install pens
+    pip install netcdf4 xarray pens
     pip install scipy==1.11.4  # to handle a dependency issue (date: 02-02-2024)
 
 and you are ready to

diff --git a/docs/_sources/ug-quickstart.rst b/docs/_sources/ug-quickstart.rst
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -155,8 +155,15 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="ug-installation.html">Installation</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="ug-examples.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/paper-fig-01.html">Figure. 1</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="ug-eg24.html">Emile-Geay et al. (2024)</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig1_motivation.html">Motivation for the study</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig2_naive_resampling.html">Reproducing Fig 2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig3_4_LMRonline.html">Making Figures 3 &amp; 4</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig5_resampling.html">Ensemble resampling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-plume_distance.html">Proximity Probability and Plume Distance</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-LMR_PMIP3_proximity_table.html">Proximity of PMIP3 traces to LMR ensembles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-compare_PAGES2k2019_recons.html">Consistency of the PAGES 2k ensemble</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-compare_LMRvsB21.html">LMR v2.1 vs Büntgen et al ensemble</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="ug-api.html">API Reference</a></li>

diff --git a/docs/index.html b/docs/index.html
@@ -157,8 +157,15 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">User Guide</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="ug-installation.html">Installation</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="ug-examples.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/paper-fig-01.html">Figure. 1</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="ug-eg24.html">Emile-Geay et al. (2024)</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig1_motivation.html">Motivation for the study</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig2_naive_resampling.html">Reproducing Fig 2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig3_4_LMRonline.html">Making Figures 3 &amp; 4</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-Fig5_resampling.html">Ensemble resampling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-plume_distance.html">Proximity Probability and Plume Distance</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-LMR_PMIP3_proximity_table.html">Proximity of PMIP3 traces to LMR ensembles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-compare_PAGES2k2019_recons.html">Consistency of the PAGES 2k ensemble</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/eg24-compare_LMRvsB21.html">LMR v2.1 vs Büntgen et al ensemble</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="ug-api.html">API Reference</a></li>
@@ -383,18 +390,18 @@ <h1>pens: utilities for comparing paleoclimate reconstruction ensembles<a class=
 <img alt="" class="sd-card-img-top" src="_images/examples.png" />
 <div class="sd-card-body custom-body docutils">
 <div class="sd-card-title sd-font-weight-bold custom-title docutils">
-Examples</div>
-<p class="sd-card-text">The examples in paper Emile-Geay et al. (2024).</p>
+Examples in Emile-Geay et al. (2024)</div>
+<p class="sd-card-text">Examples of the scientific use of the package, as introduced in Emile-Geay et al. (2024).</p>
 </div>
-<a class="sd-stretched-link reference internal" href="ug-examples.html"><span class="doc"></span></a></div>
+<a class="sd-stretched-link reference internal" href="ug-eg24.html"><span class="doc"></span></a></div>
 </div>
 <div class="sd-col sd-d-flex-row docutils">
 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
 <img alt="" class="sd-card-img-top" src="_images/api.png" />
 <div class="sd-card-body custom-body docutils">
 <div class="sd-card-title sd-font-weight-bold custom-title docutils">
-API</div>
-<p class="sd-card-text">The essential API.</p>
+package API</div>
+<p class="sd-card-text">Application programming interface of the package, name the EnsembleTS class.</p>
 </div>
 <a class="sd-stretched-link reference internal" href="ug-api.html"><span class="doc"></span></a></div>
 </div>