diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..786e2cb --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,84 @@ +cff-version: "1.2.0" +authors: +- family-names: Bartholomew + given-names: Sadie L. + orcid: "https://orcid.org/0000-0002-6180-3603" +- family-names: Colling + given-names: Lincoln + orcid: "https://orcid.org/0000-0002-3572-7758" +- family-names: Dasgupta + given-names: Abhishek + orcid: "https://orcid.org/0000-0003-4420-0656" +- family-names: Greenberg + given-names: Anthony J. + orcid: "https://orcid.org/0000-0003-3296-5811" +- family-names: Lannelongue + given-names: Loïc + orcid: "https://orcid.org/0000-0002-9135-1345" +- family-names: Lestang + given-names: Thibault + orcid: "https://orcid.org/0000-0001-6770-2638" +- family-names: Martinez-Ortiz + given-names: Carlos + orcid: "https://orcid.org/0000-0001-5565-7577" +- family-names: Sauzé + given-names: Colin + orcid: "https://orcid.org/0000-0001-5368-9217" +- family-names: Walker + given-names: Andrew M. + orcid: "https://orcid.org/0000-0003-3121-3255" +- family-names: Ward + given-names: Adam Stuart + orcid: "https://orcid.org/0009-0008-3463-2694" +contact: +- family-names: Walker + given-names: Andrew M. + orcid: "https://orcid.org/0000-0003-3121-3255" +doi: 10.5281/zenodo.15753041 +message: If you use this software, please cite our article in the + Journal of Open Source Software. +preferred-citation: + authors: + - family-names: Bartholomew + given-names: Sadie L. + orcid: "https://orcid.org/0000-0002-6180-3603" + - family-names: Colling + given-names: Lincoln + orcid: "https://orcid.org/0000-0002-3572-7758" + - family-names: Dasgupta + given-names: Abhishek + orcid: "https://orcid.org/0000-0003-4420-0656" + - family-names: Greenberg + given-names: Anthony J. + orcid: "https://orcid.org/0000-0003-3296-5811" + - family-names: Lannelongue + given-names: Loïc + orcid: "https://orcid.org/0000-0002-9135-1345" + - family-names: Lestang + given-names: Thibault + orcid: "https://orcid.org/0000-0001-6770-2638" + - family-names: Martinez-Ortiz + given-names: Carlos + orcid: "https://orcid.org/0000-0001-5565-7577" + - family-names: Sauzé + given-names: Colin + orcid: "https://orcid.org/0000-0001-5368-9217" + - family-names: Walker + given-names: Andrew M. + orcid: "https://orcid.org/0000-0003-3121-3255" + - family-names: Ward + given-names: Adam Stuart + orcid: "https://orcid.org/0009-0008-3463-2694" + date-published: 2025-07-08 + doi: 10.21105/joss.08251 + issn: 2475-9066 + issue: 111 + journal: Journal of Open Source Software + publisher: + name: Open Journals + start: 8251 + title: "CATS: The Climate Aware Task Scheduler" + type: article + url: "https://joss.theoj.org/papers/10.21105/joss.08251" + volume: 10 +title: "CATS: The Climate Aware Task Scheduler" \ No newline at end of file diff --git a/README.md b/README.md index bbfd487..7ada7be 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ The Climate-Aware Task Scheduler is a lightweight Python package designed to sch *Currently CATS only works in the UK. If you are aware of APIs for realtime grid carbon intensity data in other countries please open an issue and let us know.* +[![DOI](https://joss.theoj.org/papers/10.21105/joss.08251/status.svg)](https://doi.org/10.21105/joss.08251) + ## Features - Estimates the carbon intensity of the electricity grid in real-time diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 1c2cad1..c31b28e 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -44,10 +44,12 @@ realtime grid carbon intensity data in other countries, please Background ---------- -It was created as part of the +CATS is described in a paper published in the Journal +of Open Source Software (`doi:10.21105/joss.08251 `_) +and was created as part of the `Software Sustainability Institute’s `_ `Collaborations Workshop 2023 `_ -`Hack Day `_. +`Hack Day `_. Features