Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fzhu2e committed Apr 18, 2023
1 parent 7e84540 commit c2a06a6
Show file tree
Hide file tree
Showing 221 changed files with 697 additions and 37,695 deletions.
Binary file removed docs/_images/notebooks_compare_10_2.png
Binary file not shown.
Binary file removed docs/_images/notebooks_compare_11_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_compare_6_0.png
Binary file not shown.
Binary file removed docs/_images/notebooks_compare_9_1.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_13_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_29_0.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_33_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_34_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_37_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_3_3.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_40_1.png
Binary file not shown.
Binary file removed docs/_images/notebooks_lmr-pages2k-iCESM_41_1.png
Diff not rendered.
Binary file removed docs/_images/notebooks_lmr-pages2k_13_1.png
Diff not rendered.
Binary file removed docs/_images/notebooks_lmr-pages2k_30_1.png
Diff not rendered.
Binary file removed docs/_images/notebooks_lmr-pages2k_33_1.png
Diff not rendered.
Binary file removed docs/_images/notebooks_lmr-pages2k_34_1.png
Diff not rendered.
Binary file removed docs/_images/notebooks_lmr-pages2k_3_3.png
Diff not rendered.
Diff not rendered.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed docs/_images/notebooks_tmp_3_0.png
Diff not rendered.
Binary file removed docs/_images/notebooks_tmp_5_1.png
Diff not rendered.
2 changes: 1 addition & 1 deletion docs/_sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ It provides a toolkit for
:link: ug-api
:link-type: doc

Check the essential API.
The essential API.

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 0 additions & 6 deletions docs/_sources/notebooks/Untitled.ipynb

This file was deleted.

365 changes: 0 additions & 365 deletions docs/_sources/notebooks/compare.ipynb

This file was deleted.

3,057 changes: 0 additions & 3,057 deletions docs/_sources/notebooks/lmr-pages2k-iCESM-dOTC-BC.ipynb

This file was deleted.

3,030 changes: 0 additions & 3,030 deletions docs/_sources/notebooks/lmr-pages2k-iCESM-dOTC.ipynb

This file was deleted.

2,449 changes: 0 additions & 2,449 deletions docs/_sources/notebooks/lmr-pages2k-iCESM.ipynb

This file was deleted.

1,640 changes: 0 additions & 1,640 deletions docs/_sources/notebooks/lmr-pages2k.ipynb

This file was deleted.

118 changes: 0 additions & 118 deletions docs/_sources/notebooks/pp2k-lake.varve_thickness.ipynb

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
542 changes: 0 additions & 542 deletions docs/_sources/notebooks/tmp.ipynb

This file was deleted.

16 changes: 9 additions & 7 deletions docs/_sources/ug-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ Climate
.. autoclass:: cfr.climate.ClimateField
:members:


.. autoclass:: cfr.climate.ClimateDataset
:members:

PSM
------

Expand Down Expand Up @@ -62,8 +58,14 @@ ReconJob
.. autoclass:: cfr.reconjob.ReconJob
:members:

Visual
ReconRes
--------

.. autoclass:: cfr.reconres.ReconRes
:members:

EnsTS
--------

.. autoclass:: cfr.visual.plot_proxies
:members:
.. autoclass:: cfr.ts.EnsTS
:members:
2 changes: 1 addition & 1 deletion docs/_sources/ug-graphem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ GraphEM

.. notebooks/graphem-quickstart
notebooks/graphem-real-pages2k
.. notebooks/graphem-ppe-pages2k
notebooks/graphem-ppe-pages2k
59 changes: 53 additions & 6 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="ug-graphem.html">GraphEM</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="notebooks/graphem-real-pages2k.html">Real-world proxy experiments with GraphEM and PAGES2k</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/graphem-ppe-pages2k.html">A Pseudoproxy Experiment with GraphEM and pseudoPAGES2k</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ug-api.html">API Reference</a></li>
Expand Down Expand Up @@ -352,6 +353,10 @@ <h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.psm.Bilinear">Bilinear (class in cfr.psm)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.graphem.solver.GraphEM.bootstrap">bootstrap() (cfr.graphem.solver.GraphEM method)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -376,7 +381,11 @@ <h2 id="C">C</h2>
<li><a href="ug-api.html#cfr.climate.ClimateField">ClimateField (class in cfr.climate)</a>
</li>
<li><a href="ug-api.html#cfr.climate.ClimateField.compare">compare() (cfr.climate.ClimateField method)</a>

<ul>
<li><a href="ug-api.html#cfr.ts.EnsTS.compare">(cfr.ts.EnsTS method)</a>
</li>
</ul></li>
<li><a href="ug-api.html#cfr.climate.ClimateField.copy">copy() (cfr.climate.ClimateField method)</a>

<ul>
Expand All @@ -385,6 +394,8 @@ <h2 id="C">C</h2>
<li><a href="ug-api.html#cfr.proxy.ProxyRecord.copy">(cfr.proxy.ProxyRecord method)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.copy">(cfr.reconjob.ReconJob method)</a>
</li>
<li><a href="ug-api.html#cfr.ts.EnsTS.copy">(cfr.ts.EnsTS method)</a>
</li>
</ul></li>
</ul></td>
Expand Down Expand Up @@ -423,10 +434,14 @@ <h2 id="D">D</h2>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.graphem.solver.GraphEM.EM">EM() (cfr.graphem.solver.GraphEM method)</a>
</li>
<li><a href="ug-api.html#cfr.da.EnKF">EnKF (class in cfr.da)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.ts.EnsTS">EnsTS (class in cfr.ts)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.erase_cfg">erase_cfg() (cfr.reconjob.ReconJob method)</a>
</li>
</ul></td>
Expand All @@ -438,6 +453,10 @@ <h2 id="F">F</h2>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.filter">filter() (cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.filter_proxydb">filter_proxydb() (cfr.reconjob.ReconJob method)</a>
</li>
<li><a href="ug-api.html#cfr.graphem.solver.GraphEM.fit">fit() (cfr.graphem.solver.GraphEM method)</a>
</li>
<li><a href="ug-api.html#cfr.graphem.solver.GraphEM.fit_Sigma">fit_Sigma() (cfr.graphem.solver.GraphEM method)</a>
</li>
<li><a href="ug-api.html#cfr.psm.Coral_SrCa.forward">forward() (cfr.psm.Coral_SrCa method)</a>

Expand All @@ -452,7 +471,11 @@ <h2 id="F">F</h2>
<li><a href="ug-api.html#cfr.proxy.ProxyRecord.from_da">from_da() (cfr.proxy.ProxyRecord method)</a>
</li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.from_df">from_df() (cfr.proxy.ProxyDatabase method)</a>

<ul>
<li><a href="ug-api.html#cfr.ts.EnsTS.from_df">(cfr.ts.EnsTS method)</a>
</li>
</ul></li>
<li><a href="ug-api.html#cfr.climate.ClimateField.from_np">from_np() (cfr.climate.ClimateField method)</a>
</li>
</ul></td>
Expand All @@ -474,6 +497,8 @@ <h2 id="G">G</h2>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.proxy.ProxyRecord.get_pseudo">get_pseudo() (cfr.proxy.ProxyRecord method)</a>
</li>
<li><a href="ug-api.html#cfr.graphem.solver.GraphEM">GraphEM (class in cfr.graphem.solver)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.graphem_kcv">graphem_kcv() (cfr.reconjob.ReconJob method)</a>
</li>
Expand All @@ -496,11 +521,17 @@ <h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.psm.Lake_VarveThickness">Lake_VarveThickness (class in cfr.psm)</a>
</li>
<li><a href="ug-api.html#cfr.ts.EnsTS.line_density">line_density() (cfr.ts.EnsTS method)</a>
</li>
<li><a href="ug-api.html#cfr.psm.Linear">Linear (class in cfr.psm)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.load">load() (cfr.reconjob.ReconJob method)</a>

<ul>
<li><a href="ug-api.html#cfr.reconres.ReconRes.load">(cfr.reconres.ReconRes method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.load_clim">load_clim() (cfr.reconjob.ReconJob method)</a>
Expand All @@ -522,14 +553,22 @@ <h2 id="M">M</h2>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.mark_pids">mark_pids() (cfr.reconjob.ReconJob method)</a>
</li>
<li><a href="ug-api.html#cfr.ts.EnsTS.median">median (cfr.ts.EnsTS attribute)</a>
</li>
</ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.ts.EnsTS.nEns">nEns (cfr.ts.EnsTS attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.nrec_tags">nrec_tags() (cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.ts.EnsTS.nt">nt (cfr.ts.EnsTS attribute)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -541,16 +580,18 @@ <h2 id="P">P</h2>

<ul>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.plot">(cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.ts.EnsTS.plot">(cfr.ts.EnsTS method)</a>
</li>
</ul></li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.plot_composite">plot_composite() (cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.visual.plot_proxies">plot_proxies (class in cfr.visual)</a>
</li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.plotly">plotly() (cfr.proxy.ProxyDatabase method)</a>
<li><a href="ug-api.html#cfr.ts.EnsTS.plot_qs">plot_qs() (cfr.ts.EnsTS method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.plotly">plotly() (cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.climate.ClimateField.plotly_grid">plotly_grid() (cfr.climate.ClimateField method)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.prep_da_cfg">prep_da_cfg() (cfr.reconjob.ReconJob method)</a>
Expand All @@ -568,15 +609,17 @@ <h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.reconjob.ReconJob">ReconJob (class in cfr.reconjob)</a>
</li>
<li><a href="ug-api.html#cfr.reconres.ReconRes">ReconRes (class in cfr.reconres)</a>
</li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.refresh">refresh() (cfr.proxy.ProxyDatabase method)</a>
</li>
<li><a href="ug-api.html#cfr.climate.ClimateField.regrid">regrid() (cfr.climate.ClimateField method)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.regrid_clim">regrid_clim() (cfr.reconjob.ReconJob method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.regrid_clim">regrid_clim() (cfr.reconjob.ReconJob method)</a>
</li>
<li><a href="ug-api.html#cfr.climate.ClimateField.rename">rename() (cfr.climate.ClimateField method)</a>
</li>
<li><a href="ug-api.html#cfr.reconjob.ReconJob.run_da">run_da() (cfr.reconjob.ReconJob method)</a>
Expand Down Expand Up @@ -618,7 +661,11 @@ <h2 id="T">T</h2>
<li><a href="ug-api.html#cfr.proxy.ProxyRecord.to_da">to_da() (cfr.proxy.ProxyRecord method)</a>
</li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.to_df">to_df() (cfr.proxy.ProxyDatabase method)</a>

<ul>
<li><a href="ug-api.html#cfr.ts.EnsTS.to_df">(cfr.ts.EnsTS method)</a>
</li>
</ul></li>
<li><a href="ug-api.html#cfr.proxy.ProxyDatabase.to_ds">to_ds() (cfr.proxy.ProxyDatabase method)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -687,7 +734,7 @@ <h2 id="W">W</h2>

<p class="copyright">

© Copyright 2023, Feng Zhu, Julien Emile-Geay..
© Copyright 2023, Feng Zhu, Julien Emile-Geay.
<br/>

</p>
Expand Down
5 changes: 3 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="ug-graphem.html">GraphEM</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="notebooks/graphem-real-pages2k.html">Real-world proxy experiments with GraphEM and PAGES2k</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/graphem-ppe-pages2k.html">A Pseudoproxy Experiment with GraphEM and pseudoPAGES2k</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ug-api.html">API Reference</a></li>
Expand Down Expand Up @@ -465,7 +466,7 @@ <h1><cite>cfr</cite>: a Python package for Climate Field Reconstruction<a class=
<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">Check the essential API.</p>
<p class="sd-card-text">The essential API.</p>
</div>
<a class="sd-stretched-link reference internal" href="ug-api.html"><span class="doc"></span></a></div>
</div>
Expand Down Expand Up @@ -514,7 +515,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 2023, Feng Zhu, Julien Emile-Geay.
<br/>

</p>
Expand Down
Loading

0 comments on commit c2a06a6

Please sign in to comment.