Skip to content

Commit

Permalink
docs: update authors and description (xarray-contrib#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicrie authored Nov 1, 2023
2 parents 5aaf7be + 3e39eda commit 49c4367
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
:alt: Test Coverage

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6323012.svg
:target: https://doi.org/10.5281/zenodo.6323012
:target: https://doi.org/10.5281/10.5281/zenodo.6323011
:alt: DOI - Zenodo

.. |license| image:: https://img.shields.io/pypi/l/xeofs
Expand Down Expand Up @@ -201,15 +201,16 @@ Credits

How to cite?
----------------------
When utilizing ``xeofs``, kindly remember to cite the original creators of the methods employed in your work. Additionally, if ``xeofs`` is proving useful in your research, I'd appreciate if you could acknowledge its use with the following citation:
When using ``xeofs``, kindly remember to cite the original references of the methods employed in your work.
Additionally, if ``xeofs`` is proving useful in your research, we'd appreciate if you could acknowledge its use with the following citation:

.. code-block:: bibtex
@software{rieger_xeofs_2023,
title = {xeofs: Multi-dimensional {EOF} analysis and variants in xarray},
title = {xeofs: Comprehensive EOF analysis in Python with xarray: A versatile, multidimensional, and scalable tool for advanced climate data analysis},
url = {https://github.com/nicrie/xeofs}
version = {1.x.y},
author = {Rieger, Niclas},
version = {x.y.z},
author = {Rieger, N. and Levang, S. J.},
date = {2023},
doi = {10.5281/zenodo.6323011}
}
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "xeofs"
version = "1.2.2"
description = "Collection of EOF analysis and related techniques for climate science"
description = "Comprehensive EOF analysis in Python with xarray: A versatile, multidimensional, and scalable tool for advanced climate data analysis"
authors = ["Niclas Rieger <[email protected]>"]
license = "MIT"
readme = "README.rst"
Expand Down

0 comments on commit 49c4367

Please sign in to comment.