From abb4444178807a8989fc13d4e34502abe1cdbdeb Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:18:19 -0700 Subject: [PATCH] Update eofs links and descriptions (#661) * update eofs links and description in stats.py * update release-notes.rst --- docs/release-notes.rst | 1 + geocat/comp/stats.py | 17 +++++++++-------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index d0bd4eb09..d2b20a59c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -15,6 +15,7 @@ This release... Documentation ^^^^^^^^^^^^^ * Fix to documentation theme configuration by `Katelyn FitzGerald`_ in (:pr:`657`) +* Update links to eofs documentation by `Katelyn FitzGerald`_ in (:pr:`661`) Internal Changes ^^^^^^^^^^^^^^^^ diff --git a/geocat/comp/stats.py b/geocat/comp/stats.py index 889bc06de..2cd24ba22 100644 --- a/geocat/comp/stats.py +++ b/geocat/comp/stats.py @@ -121,11 +121,11 @@ def eofunc_eofs(data, 2. EOFs are computed only from covariance matrix and there is no support for computation from correlation matrix, 3. percentage of non-missing points that must exist at any single point is no longer an input. - This implementation uses the `eofs package `__, - which is built upon the following study: Dawson, Andrew, "eofs: A library + This implementation uses the `eofs package `__, + documented in the following paper: Dawson, Andrew, "eofs: A library for EOF analysis of meteorological, oceanographic, and climate data," - Journal of Open Research Software, vol. 4, no. 1, 2016. Further information about this - package can be found `here `__. + Journal of Open Research Software, vol. 4, no. 1, 2016. Further information can be + found in the `eofs documentation `__. This implementation provides a few conveniences to the user on top of ``eofs`` package that are described below. @@ -286,10 +286,11 @@ def eofunc_pcs(data, 2. EOFs are computed only from covariance matrix and there is no support for computation from correlation matrix, 3. percentage of non-missing points that must exist at any single point is no longer an input. - This implementation uses `eofs package `__, which is built upon the - following study: Dawson, Andrew, "eofs: A library for EOF analysis of meteorological, oceanographic, and - climate data," Journal of Open Research Software, vol. 4, no. 1, 2016. Further information about this - package can be found `here `__. + This implementation uses the `eofs package `__, + documented in the following paper: Dawson, Andrew, "eofs: A library + for EOF analysis of meteorological, oceanographic, and climate data," + Journal of Open Research Software, vol. 4, no. 1, 2016. Further information can be + found in the `eofs documentation `__. This implementation provides a few conveniences to the user on top of ``eofs`` package that are described below in the Parameters section.