Updated citation (#5116)

* Updated citation * Added WhatsNew * Reference version 3.4 in DOI Co-authored-by: Bouwe Andela <bouweandela@gmail.com> * Suggest updating the citation at every release Co-authored-by: Bouwe Andela <bouweandela@gmail.com>
SciTools · Jan 13, 2023 · 769d7f0 · 769d7f0
1 parent e883799
commit 769d7f0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git 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 <https://doi.org/10.5281/zenodo.595182>`_ 
+   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

diff --git 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.7386117}
  }
 
 
@@ -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
 

diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
@@ -72,6 +72,8 @@ This document explains the changes made to Iris for this release
    the light version (not dark) while we make the docs dark mode friendly
    (:pull:`5129`)
 
+#. `@jonseddon`_ updated the citation to a more recent version of Iris. (:pull:`5116`)
+
 #. `@rcomer`_ linked the :obj:`~iris.analysis.PERCENTILE` aggregator from the
    :obj:`~iris.analysis.MEDIAN` docstring, noting that the former handles lazy
    data. (:pull:`5128`)