From 3e39edaa22e9e28ff2140a414af9d1fb82194d67 Mon Sep 17 00:00:00 2001 From: Niclas Rieger Date: Wed, 1 Nov 2023 13:02:01 +0100 Subject: [PATCH] docs: update authors and description --- README.rst | 11 ++++++----- pyproject.toml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 7531a4d..48d2ddd 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -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} } diff --git a/pyproject.toml b/pyproject.toml index d68ede7..42462a9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 "] license = "MIT" readme = "README.rst"