Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated citation #5116

Merged
merged 6 commits into from
Jan 13, 2023
+14 −6
Merged

Updated citation #5116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e676890
Updated citation
jonseddon Dec 20, 2022
8d73dd4
Added WhatsNew
jonseddon Dec 20, 2022
edd08f3
Reference version 3.4 in DOI
jonseddon Jan 3, 2023
1048b6b
Merge branch 'main' of github.com:SciTools/iris into recent-citation
jonseddon Jan 3, 2023
934f74c
Suggest updating the citation at every release
jonseddon Jan 12, 2023
cfb9f4f
Merge branch 'main' of github.com:SciTools/iris into recent-citation
jonseddon Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/src/developers_guide/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 7 additions & 6 deletions docs/src/userguide/citation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
}


Expand All @@ -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


********************
Expand All @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down