Skip to content

Commit 769d7f0

Browse files
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>
1 parent e883799 commit 769d7f0

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

docs/src/developers_guide/release.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,11 @@ Post Release Steps
277277
#. On main, make a new ``latest.rst`` from ``latest.rst.template`` and update
278278
the include statement and the toctree in ``index.rst`` to point at the new
279279
``latest.rst``.
280+
#. Consider updating ``docs/src/userguide/citation.rst`` on ``main`` to include
281+
the version number, date and `Zenodo DOI <https://doi.org/10.5281/zenodo.595182>`_
282+
of the new release. Ideally this would be updated before the release, but
283+
the DOI for the new version is only available once the release has been
284+
created in GitHub.
280285

281286

282287
.. _SciTools/iris: https://github.com/SciTools/iris

docs/src/userguide/citation.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ For example::
1515

1616
@manual{Iris,
1717
author = {{Met Office}},
18-
title = {Iris: A Python package for analysing and visualising meteorological and oceanographic data sets},
19-
edition = {v1.2},
20-
year = {2010 - 2013},
18+
title = {Iris: A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data },
19+
edition = {v3.4},
20+
year = {2010 - 2022},
2121
address = {Exeter, Devon },
22-
url = {http://scitools.org.uk/}
22+
url = {http://scitools.org.uk/},
23+
doi = {10.5281/zenodo.7386117}
2324
}
2425

2526

@@ -33,7 +34,7 @@ Suggested format::
3334

3435
For example::
3536

36-
Iris. v1.2. 28-Feb-2013. Met Office. UK. https://github.com/SciTools/iris/archive/v1.2.0.tar.gz 01-03-2013
37+
Iris. v3.4. 1-Dec-2022. Met Office. UK. https://doi.org/10.5281/zenodo.7386117 22-12-2022
3738

3839

3940
********************
@@ -46,7 +47,7 @@ Suggested format::
4647

4748
For example::
4849

49-
Iris. Met Office. git@github.com:SciTools/iris.git 06-03-2013
50+
Iris. Met Office. git@github.com:SciTools/iris.git 22-12-2022
5051

5152
.. _How to cite and describe software: https://software.ac.uk/how-cite-software
5253

docs/src/whatsnew/latest.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ This document explains the changes made to Iris for this release
7272
the light version (not dark) while we make the docs dark mode friendly
7373
(:pull:`5129`)
7474

75+
#. `@jonseddon`_ updated the citation to a more recent version of Iris. (:pull:`5116`)
76+
7577
#. `@rcomer`_ linked the :obj:`~iris.analysis.PERCENTILE` aggregator from the
7678
:obj:`~iris.analysis.MEDIAN` docstring, noting that the former handles lazy
7779
data. (:pull:`5128`)

0 commit comments

Comments
 (0)