From b244aec423dc3e36fbe23b227460bb033c3c9903 Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Wed, 6 Sep 2023 16:53:51 +0100 Subject: [PATCH 1/7] add citation file and validating GHA --- .github/workflows/ci-citation | 30 ++++++++++++++++++++++++++++++ CITATION.cff | 11 +++++++++++ 2 files changed, 41 insertions(+) create mode 100644 .github/workflows/ci-citation create mode 100644 CITATION.cff diff --git a/.github/workflows/ci-citation b/.github/workflows/ci-citation new file mode 100644 index 0000000000..64bd16f8c5 --- /dev/null +++ b/.github/workflows/ci-citation @@ -0,0 +1,30 @@ +name: ci-citation + +on: + pull_request: + paths: + - "CITATION.cff" + + push: + paths: + - "CITATION.cff" + + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + validate: + name: "validate" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: "check CITATION.cff" + uses: citation-file-format/cffconvert-github-action@2.0.0 + with: + args: "--validate" diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..75867a84c0 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,11 @@ +cff-version: 1.2.0 +message: "If Iris played an important part in your research then please add us to your reference list by using the references below." +title: "Iris" +authors: + - "The Iris development team" +abstract: "A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data" +license: "LGPL-3.0" +doi: "10.5281/zenodo.595182" +url: "http://scitools.org.uk/" +repository-code: "https://github.com/SciTools/iris" +type: "software" From ef54a76fee83f42380f76109a368a3642e34746b Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Thu, 7 Sep 2023 14:45:55 +0100 Subject: [PATCH 2/7] adding the CITATION.cff to the manifest file --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) diff --git a/MANIFEST.in b/MANIFEST.in index 329cf79c5d..4d29894a22 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -19,6 +19,7 @@ exclude CODE_OF_CONDUCT.md exclude codecov.yml include COPYING include COPYING.LESSER +include CITATION.cff exclude Makefile exclude noxfile.py From 1292e5db5fa20919074126044c296bea5751afb7 Mon Sep 17 00:00:00 2001 From: Henry Wright <84939917+HGWright@users.noreply.github.com> Date: Wed, 27 Sep 2023 12:05:28 +0100 Subject: [PATCH 3/7] added - name: to CITATION.cff --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 75867a84c0..fc58b6c78d 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,7 +2,7 @@ cff-version: 1.2.0 message: "If Iris played an important part in your research then please add us to your reference list by using the references below." title: "Iris" authors: - - "The Iris development team" + - name: "Iris contributors" abstract: "A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data" license: "LGPL-3.0" doi: "10.5281/zenodo.595182" From f65d8582c8ae3d3ddd4874a0322290ee826b2ab9 Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Thu, 21 Dec 2023 13:13:44 +0000 Subject: [PATCH 4/7] some of the requested changes --- .github/workflows/{ci-citation => ci-citation.yml} | 4 ++-- CITATION.cff | 14 +++++++++++++- 2 files changed, 15 insertions(+), 3 deletions(-) rename .github/workflows/{ci-citation => ci-citation.yml} (75%) diff --git a/.github/workflows/ci-citation b/.github/workflows/ci-citation.yml similarity index 75% rename from .github/workflows/ci-citation rename to .github/workflows/ci-citation.yml index 64bd16f8c5..99cced758b 100644 --- a/.github/workflows/ci-citation +++ b/.github/workflows/ci-citation.yml @@ -20,11 +20,11 @@ jobs: name: "validate" runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - name: "check CITATION.cff" - uses: citation-file-format/cffconvert-github-action@2.0.0 + uses: citation-file-format/cffconvert-github-action@4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 with: args: "--validate" diff --git a/CITATION.cff b/CITATION.cff index 75867a84c0..d8ef2ee6bf 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,10 +1,22 @@ cff-version: 1.2.0 message: "If Iris played an important part in your research then please add us to your reference list by using the references below." title: "Iris" +keywords: + - "cf-metadata" + - "data-analysis" + - "earth-science" + - "grib" + - "netcdf" + - "meteorology" + - "oceanography" + - "space-weather" + - "ugrid" + - "visualisation" authors: - "The Iris development team" abstract: "A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data" -license: "LGPL-3.0" +license: "BSD-3-Clause" +license-url: "https://spdx.org/licenses/BSD-3-Clause.html" doi: "10.5281/zenodo.595182" url: "http://scitools.org.uk/" repository-code: "https://github.com/SciTools/iris" From 5443c7580b8d6aaf113194649d4b5a6c0a736369 Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Fri, 22 Dec 2023 13:59:57 +0000 Subject: [PATCH 5/7] updating the citation page and adding whatsnew entry --- docs/src/userguide/citation.rst | 56 ++++++--------------------------- docs/src/whatsnew/latest.rst | 4 +++ 2 files changed, 13 insertions(+), 47 deletions(-) diff --git a/docs/src/userguide/citation.rst b/docs/src/userguide/citation.rst index 7169ca3072..4834baf34b 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -5,53 +5,15 @@ Citing Iris =========== If Iris played an important part in your research then please add us to your -reference list by using one of the recommendations below. +reference list by using the recommendations below. -************ -BibTeX Entry -************ +IRIS can be cited directly from the GitHub repository. -For example:: +The IRIS citation does not contain the version of the software used. We +recommend that you use the version number of the release you used, and the +commit hash of the version you used. This will allow others to reproduce the +environment that you worked in. - @manual{Iris, - author = {{Met Office}}, - title = {Iris: A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data}, - edition = {v3.7}, - year = {2010 - 2023}, - address = {Exeter, Devon}, - url = {https://github.com/SciTools/iris}, - doi = {10.5281/zenodo.8305232} - } - - -******************* -Downloaded Software -******************* - -Suggested format:: - - ProductName. Version. ReleaseDate. Publisher. Location. DOIorURL. DownloadDate. - -For example:: - - Iris. v3.7. 31-Aug-2023. Met Office. UK. https://doi.org/10.5281/zenodo.8305232 22-12-2022 - - -******************** -Checked Out Software -******************** - -Suggested format:: - - ProductName. Publisher. URL. CheckoutDate. RepositorySpecificCheckoutInformation. - -For example:: - - Iris. Met Office. https://github.com/SciTools/iris.git 31-08-2023 - -.. _How to cite and describe software: https://software.ac.uk/how-cite-software - - -Reference: [Jackson]_. - -.. [Jackson] Jackson, M. 2012. `How to cite and describe software`_. Accessed 06-03-2013. +You can find what a citation should look like for a particular version of IRIS, +and where to find the citation on GitHub by looking at the `documentation GitHub +has for citing repositories. `_ diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 13e3b9e4ea..6ae3bfc05b 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -26,6 +26,10 @@ This document explains the changes made to Iris for this release #. `@lbdreyer`_ relicensed Iris from LGPL-3 to BSD-3. (:pull: `5577`) +#. `@HGWright`_, `@bjlittle`_ and `@trexfeathers`_ (reviewers) added a + CITATION.cff file to Iris and updated the citation documentation, to help + users cite Iris in their work. (:pull:`5483`) + ✨ Features =========== From 4a827eaf96de4217725c01e1add78ea6c5b03800 Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Fri, 22 Dec 2023 14:15:24 +0000 Subject: [PATCH 6/7] adding repository link --- 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 4834baf34b..4782e775c4 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -7,7 +7,7 @@ Citing Iris If Iris played an important part in your research then please add us to your reference list by using the recommendations below. -IRIS can be cited directly from the GitHub repository. +IRIS can be cited directly from the `GitHub repository. `_ The IRIS citation does not contain the version of the software used. We recommend that you use the version number of the release you used, and the From f6110829b61b6e784f3675cdf9489d1b782b363b Mon Sep 17 00:00:00 2001 From: Henry Wright Date: Fri, 22 Dec 2023 15:22:22 +0000 Subject: [PATCH 7/7] rewording and adding more links --- docs/src/userguide/citation.rst | 15 ++++++++------- docs/src/whatsnew/latest.rst | 4 ++-- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/src/userguide/citation.rst b/docs/src/userguide/citation.rst index 4782e775c4..d0496f4876 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -7,13 +7,14 @@ Citing Iris If Iris played an important part in your research then please add us to your reference list by using the recommendations below. -IRIS can be cited directly from the `GitHub repository. `_ +Iris can be cited directly from the `GitHub repository `_ +, for more information including where to find the citation on the repo please +see the `GitHub documentation`_. -The IRIS citation does not contain the version of the software used. We +The Iris citation does not contain the version of the software used. We recommend that you use the version number of the release you used, and the -commit hash of the version you used. This will allow others to reproduce the -environment that you worked in. +commit hash if you checked out a unreleased version of Iris. This will allow +others to reproduce the environment that you worked in. You can see what a +citation should look like for a particular version of Iris, on the `GitHub documentation`_. -You can find what a citation should look like for a particular version of IRIS, -and where to find the citation on GitHub by looking at the `documentation GitHub -has for citing repositories. `_ +.. _GitHub documentation: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files/ diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 6ae3bfc05b..f73d6b0090 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -27,8 +27,8 @@ This document explains the changes made to Iris for this release #. `@lbdreyer`_ relicensed Iris from LGPL-3 to BSD-3. (:pull: `5577`) #. `@HGWright`_, `@bjlittle`_ and `@trexfeathers`_ (reviewers) added a - CITATION.cff file to Iris and updated the citation documentation, to help - users cite Iris in their work. (:pull:`5483`) + CITATION.cff file to Iris and updated the :ref:`citation documentation ` + , to help users cite Iris in their work. (:pull:`5483`) ✨ Features