From e676890ce97b33b07b43ac21a1b798f46bae27f2 Mon Sep 17 00:00:00 2001 From: Jon Seddon Date: Tue, 20 Dec 2022 12:02:44 +0000 Subject: [PATCH 1/4] Updated citation --- docs/src/userguide/citation.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/src/userguide/citation.rst b/docs/src/userguide/citation.rst index 0a3a85fb89..fdfb1dc17f 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -15,11 +15,12 @@ For example:: @manual{Iris, author = {{Met Office}}, - title = {Iris: A Python package for analysing and visualising meteorological and oceanographic data sets}, - edition = {v1.2}, - year = {2010 - 2013}, + title = {Iris: A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data }, + edition = {v3.4}, + year = {2010 - 2022}, address = {Exeter, Devon }, - url = {http://scitools.org.uk/} + url = {http://scitools.org.uk/}, + doi = {10.5281/zenodo.595182} } @@ -33,7 +34,7 @@ Suggested format:: For example:: - Iris. v1.2. 28-Feb-2013. Met Office. UK. https://github.com/SciTools/iris/archive/v1.2.0.tar.gz 01-03-2013 + Iris. v3.4. 1-Dec-2022. Met Office. UK. https://doi.org/10.5281/zenodo.7386117 22-12-2022 ******************** @@ -46,7 +47,7 @@ Suggested format:: For example:: - Iris. Met Office. git@github.com:SciTools/iris.git 06-03-2013 + Iris. Met Office. git@github.com:SciTools/iris.git 22-12-2022 .. _How to cite and describe software: https://software.ac.uk/how-cite-software From 8d73dd491d5b317f4747e2b6cb0140f81dae381b Mon Sep 17 00:00:00 2001 From: Jon Seddon Date: Tue, 20 Dec 2022 12:09:05 +0000 Subject: [PATCH 2/4] Added WhatsNew --- docs/src/whatsnew/latest.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index d1aae76675..0d310147c9 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -69,6 +69,8 @@ This document explains the changes made to Iris for this release #. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`) +#. `@jonseddon`_ updated the citation to a more recent version of Iris. (:pull:`5116`) + 💼 Internal =========== From edd08f3b933a537a822b42a7de21af34197eb682 Mon Sep 17 00:00:00 2001 From: Jon Seddon <17068361+jonseddon@users.noreply.github.com> Date: Tue, 3 Jan 2023 12:37:56 +0000 Subject: [PATCH 3/4] Reference version 3.4 in DOI Co-authored-by: Bouwe Andela --- docs/src/userguide/citation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/userguide/citation.rst b/docs/src/userguide/citation.rst index fdfb1dc17f..1498b9dfe1 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -20,7 +20,7 @@ For example:: year = {2010 - 2022}, address = {Exeter, Devon }, url = {http://scitools.org.uk/}, - doi = {10.5281/zenodo.595182} + doi = {10.5281/zenodo.7386117} } From 934f74c6a56ed2a55f550782fe69a5bb9763b629 Mon Sep 17 00:00:00 2001 From: Jon Seddon Date: Thu, 12 Jan 2023 17:47:19 +0000 Subject: [PATCH 4/4] Suggest updating the citation at every release --- docs/src/developers_guide/release.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index de7aa6c719..bae77a7d21 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -277,6 +277,11 @@ Post Release Steps #. On main, make a new ``latest.rst`` from ``latest.rst.template`` and update the include statement and the toctree in ``index.rst`` to point at the new ``latest.rst``. +#. Consider updating ``docs/src/userguide/citation.rst`` on ``main`` to include + the version number, date and `Zenodo DOI `_ + of the new release. Ideally this would be updated before the release, but + the DOI for the new version is only available once the release has been + created in GitHub. .. _SciTools/iris: https://github.com/SciTools/iris