update docs

fzhu2e · Jul 1, 2024 · 61ece27 · 61ece27
1 parent 792e647
commit 61ece27
Show file tree

Hide file tree

Showing 51 changed files with 61 additions and 862 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,10 @@
 # `cfr`: a Python package for Climate Field Reconstruction
 
 > [!NOTE]
-> Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. https://doi.org/10.5194/gmd-17-3409-2024
+> If you use `cfr` in any way for your publications, please cite:
+> 
+> + Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. https://doi.org/10.5194/gmd-17-3409-2024
+> + Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. https://doi.org/10.1038/s41597-023-02489-1
 
 `cfr` aims to provide a universal framework for climate field reconstruction (CFR).
 It provides a toolkit for

diff --git a/docs/_images/notebooks_psm-ocn-TEX86_1_0.png b/docs/_images/notebooks_psm-ocn-TEX86_1_0.png
diff --git a/docs/_sources/index.rst b/docs/_sources/index.rst
@@ -3,7 +3,11 @@
 ***********************************************************
 
 .. note::
-    Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. https://doi.org/10.5194/gmd-17-3409-2024
+    If you use `cfr` in any way for your publications, please cite:
+
+    + Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. https://doi.org/10.5194/gmd-17-3409-2024
+    + Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. https://doi.org/10.1038/s41597-023-02489-1
+
 
 `cfr` aims to provide a universal framework for climate field reconstruction (CFR).
 It provides a toolkit for

diff --git a/docs/_sources/notebooks/psm-ocn-TEX86.ipynb b/docs/_sources/notebooks/psm-ocn-TEX86.ipynb
diff --git a/docs/cg-overview.html b/docs/cg-overview.html
@@ -525,7 +525,7 @@ <h2>Bug reports and enhancement requests<a class="headerlink" href="#bug-reports
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/cg-updating-docs.html b/docs/cg-updating-docs.html
@@ -541,7 +541,7 @@ <h2>Pushing your changes<a class="headerlink" href="#pushing-your-changes" title
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/cg-working-with-codebase.html b/docs/cg-working-with-codebase.html
@@ -717,7 +717,7 @@ <h2>Tips for a successful pull request<a class="headerlink" href="#tips-for-a-su
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -836,7 +836,7 @@ <h2 id="W">W</h2>
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/index.html b/docs/index.html
@@ -420,7 +420,11 @@ <h1>cfr: a Python package for Climate Field Reconstruction</h1>
 <h1><cite>cfr</cite>: a Python package for Climate Field Reconstruction<a class="headerlink" href="#cfr-a-python-package-for-climate-field-reconstruction" title="Link to this heading">#</a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., &amp; Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. <a class="reference external" href="https://doi.org/10.5194/gmd-17-3409-2024">https://doi.org/10.5194/gmd-17-3409-2024</a></p>
+<p>If you use <cite>cfr</cite> in any way for your publications, please cite:</p>
+<ul class="simple">
+<li><p>Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., &amp; Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. <a class="reference external" href="https://doi.org/10.5194/gmd-17-3409-2024">https://doi.org/10.5194/gmd-17-3409-2024</a></p></li>
+<li><p>Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. <a class="reference external" href="https://doi.org/10.1038/s41597-023-02489-1">https://doi.org/10.1038/s41597-023-02489-1</a></p></li>
+</ul>
 </div>
 <p><cite>cfr</cite> aims to provide a universal framework for climate field reconstruction (CFR).
 It provides a toolkit for</p>
@@ -567,7 +571,7 @@ <h1><cite>cfr</cite>: a Python package for Climate Field Reconstruction<a class=
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/climate-io.html b/docs/notebooks/climate-io.html
@@ -3848,7 +3848,7 @@ <h3>Remote loading iCESM simulations<a class="headerlink" href="#Remote-loading-
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/climate-ops.html b/docs/notebooks/climate-ops.html
@@ -7675,7 +7675,7 @@ <h2>Validate a field against another<a class="headerlink" href="#Validate-a-fiel
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/graphem-cli.html b/docs/notebooks/graphem-cli.html
@@ -1169,7 +1169,7 @@ <h2>Validation<a class="headerlink" href="#Validation" title="Link to this headi
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/graphem-primer.html b/docs/notebooks/graphem-primer.html
@@ -2437,7 +2437,7 @@ <h3>Timeseries comparison<a class="headerlink" href="#id3" title="Link to this h
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/graphem-real-pages2k.html b/docs/notebooks/graphem-real-pages2k.html
@@ -1364,7 +1364,7 @@ <h2>Comparison to the LMR/PDA based reconstruction<a class="headerlink" href="#C
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/lmr-assim-no-calib.html b/docs/notebooks/lmr-assim-no-calib.html
@@ -1420,7 +1420,7 @@ <h2>Validation<a class="headerlink" href="#Validation" title="Link to this headi
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/lmr-cli.html b/docs/notebooks/lmr-cli.html
@@ -1051,7 +1051,7 @@ <h2>Leveraging the CLI<a class="headerlink" href="#Leveraging-the-CLI" title="Li
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/lmr-real-pages2k.html b/docs/notebooks/lmr-real-pages2k.html
@@ -1820,7 +1820,7 @@ <h3>Timeseries validation<a class="headerlink" href="#Timeseries-validation" tit
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/lmr-recon-pr.html b/docs/notebooks/lmr-recon-pr.html
@@ -1115,7 +1115,7 @@ <h3>Field validation<a class="headerlink" href="#Field-validation" title="Link t
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/pp2k-dashboards.html b/docs/notebooks/pp2k-dashboards.html
@@ -906,7 +906,7 @@ <h2>Dashboard for a <code class="docutils literal notranslate"><span class="pre"
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/pp2k-pdb-filter.html b/docs/notebooks/pp2k-pdb-filter.html
@@ -776,7 +776,7 @@ <h3>By a circle (center + distance)<a class="headerlink" href="#By-a-circle-(cen
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/pp2k-pdb-load-viz.html b/docs/notebooks/pp2k-pdb-load-viz.html
@@ -1580,7 +1580,7 @@ <h2>Check the <strong>proxy IDs</strong> on an interactive map<a class="headerli
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/pp2k-ppe-graphem.html b/docs/notebooks/pp2k-ppe-graphem.html
@@ -1625,7 +1625,7 @@ <h3>Validate the reconstructed fields<a class="headerlink" href="#Validate-the-r
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/pp2k-ppe-pda.html b/docs/notebooks/pp2k-ppe-pda.html
@@ -1316,7 +1316,7 @@ <h3>Validate the reconstructed fields<a class="headerlink" href="#Validate-the-r
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/proxy-analysis.html b/docs/notebooks/proxy-analysis.html
@@ -619,7 +619,7 @@ <h2>Annualize a <code class="docutils literal notranslate"><span class="pre">Pro
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/proxy-composites.html b/docs/notebooks/proxy-composites.html
@@ -1039,7 +1039,7 @@ <h2>Make a composite of multiple archives<a class="headerlink" href="#Make-a-com
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/proxy-dups.html b/docs/notebooks/proxy-dups.html
@@ -690,7 +690,7 @@ <h2>Find the duplicates<a class="headerlink" href="#Find-the-duplicates" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/proxy-io.html b/docs/notebooks/proxy-io.html
@@ -1359,7 +1359,7 @@ <h2>a netCDF file =&gt; <code class="docutils literal notranslate"><span class="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/proxy-ops.html b/docs/notebooks/proxy-ops.html
@@ -1053,7 +1053,7 @@ <h2>Filter a <code class="docutils literal notranslate"><span class="pre">ProxyD
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-bilinear.html b/docs/notebooks/psm-bilinear.html
@@ -1184,7 +1184,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-coral-SrCa.html b/docs/notebooks/psm-coral-SrCa.html
@@ -652,7 +652,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-coral-d18O.html b/docs/notebooks/psm-coral-d18O.html
@@ -654,7 +654,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-ice-d18O.html b/docs/notebooks/psm-ice-d18O.html
@@ -1114,7 +1114,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-lake-VarveThickness.html b/docs/notebooks/psm-lake-VarveThickness.html
@@ -648,7 +648,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>

diff --git a/docs/notebooks/psm-linear.html b/docs/notebooks/psm-linear.html
@@ -1786,7 +1786,7 @@ <h2>Create a PSM object<a class="headerlink" href="#Create-a-PSM-object" title="
 
   <p class="copyright">
 
-      © Copyright 2023, Feng Zhu, Julien Emile-Geay.
+      © Copyright 2024, Feng Zhu, Julien Emile-Geay.
       <br/>
 
   </p>