Skip to content

Commit

Permalink
Update eofs links and descriptions (#661)
Browse files Browse the repository at this point in the history
* update eofs links and description in stats.py

* update release-notes.rst
  • Loading branch information
kafitzgerald authored Nov 19, 2024
1 parent bd8b779 commit abb4444
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^
Expand Down
17 changes: 9 additions & 8 deletions geocat/comp/stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://anaconda.org/conda-forge/eofs>`__,
which is built upon the following study: Dawson, Andrew, "eofs: A library
This implementation uses the `eofs package <https://github.com/ajdawson/eofs>`__,
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 <https://ajdawson.github.io/eofs/latest/index.html>`__.
Journal of Open Research Software, vol. 4, no. 1, 2016. Further information can be
found in the `eofs documentation <https://ajdawson.github.io/eofs/>`__.
This implementation provides a few conveniences to the user on top of
``eofs`` package that are described below.
Expand Down Expand Up @@ -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 <https://anaconda.org/conda-forge/eofs>`__, 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 <https://ajdawson.github.io/eofs/latest/index.html>`__.
This implementation uses the `eofs package <https://github.com/ajdawson/eofs>`__,
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 <https://ajdawson.github.io/eofs/>`__.
This implementation provides a few conveniences to the user on top of ``eofs`` package that are described below
in the Parameters section.
Expand Down

0 comments on commit abb4444

Please sign in to comment.