From 16577b97f03727ea4be98742e5fbe5f0f78d14c3 Mon Sep 17 00:00:00 2001 From: CommonClimate Date: Thu, 12 Dec 2024 13:49:08 -0800 Subject: [PATCH] added context to ug-eg24.rst --- docsrc/ug-eg24.rst | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docsrc/ug-eg24.rst b/docsrc/ug-eg24.rst index b89a69e..07e0c1c 100644 --- a/docsrc/ug-eg24.rst +++ b/docsrc/ug-eg24.rst @@ -1,7 +1,22 @@ -Emile-Geay et al. (2024) -======================== -This section shows the usage of `pens` as in the paper entitled *Temporal Comparisons Involving Paleoclimate Data Assimilation: Challenges & Remedies* (Emile-Geay et al., 2024, doi:10.1175/JCLI-D-24-0101.1). +Paleoclimate Ensembles and Offline Data Assimilation +==================================================== +This page gathers notebooks showing the usage of the `pens` package [#pens]_ as used in the article *"Temporal Comparisons Involving Paleoclimate Data Assimilation: Challenges & Remedies"* [#article]_, by Julien Emile-Geay, Gregory J. Hakim, Frederi Viens, Feng Zhu and Daniel E. Amrhein. + +There are two main uses to these notebooks: + +1. **Understand the genesis and properties of a new tool** introduced in the paper, called **"plume distance"**, which is broadly applicable to all manner of ensembles as used in climate science (broadly defined). Indeed, while the article focused on paleoclimate reconstruction ensembles (particularly those generated by "offline" data assimilation methods), the plume distance can help quantify distance between timeseries generated by initial condition ensembles (e.g. like [#initial-conditions]_), observational ensembles obtained by [#resampling]_, or `any other kind` [#other-ensembles]_ (e.g. perturbed parameter ensembles). + +2. **Reproduce results from the paper**, which showcases several useful Python packages to do paleoclimatology in the Cloud, including `pens` [#pens-pypi]_, `xarray` [#xarray]_, and `Pyleoclim` [#pyleoclim]_. + +.. [#pens] https://doi.org/10.5281/zenodo.14397028 +.. [#article] https://doi.org/10.1175/JCLI-D-24-0101.1 +.. [#initial-conditions] https://doi.org/10.1038/s41558-020-0731-2 +.. [#resampling] https://doi.org/10.1175/JCLI-D-17-0901.1 +.. [#other-ensembles] https://doi.org/10.1098/rsta.2007.2076 +.. [#pens-pypi] https://pypi.org/project/pens/ +.. [#xarray] https://docs.xarray.dev/en/stable/index.html# +.. [#pyleoclim] https://github.com/LinkedEarth/Pyleoclim_util .. toctree:: :maxdepth: 1