Add Citation section in README.md + docs (#24)

* Add citation section in README.md * add citation section in docs * update repo creators * fix sam's affiliation
ACCESS-Community-Hub · Dec 19, 2024 · f7547c6 · f7547c6
1 parent 171f7a1
commit f7547c6
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -25,6 +25,12 @@
          "orcid":"0000-0001-7354-295X",
          "type":"ProjectMember"
       },
+      {
+         "affiliation":"UNSW Sydney",
+         "name":"Samuel Green",
+         "orcid":"0000-0003-1129-4676",
+         "type":"ProjectMember"
+      },      
       {
          "affiliation":"University of Melbourne",
          "name":"Christopher Chambers",

diff --git a/README.md b/README.md
@@ -6,6 +6,11 @@
     <img alt="latest docs" src="https://img.shields.io/badge/docs-latest-blue.svg">
 </a>
 
+<a href="https://doi.org/10.5281/zenodo.14503323">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14503323.svg" alt="DOI">
+</a>
+
+
 # Atmosphere Cookbook
 
 An Atmosphere Cookbook 📔 of Recipes for analysing regional or global atmosphere model output. 👩🏽‍🍳 👨🏻‍🍳
@@ -46,3 +51,11 @@ If you can find a recipe that suits your purpose, then this is a great place to
 
 The structure and content of this repository draws inspiration from the [Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA)](http://cosima.org.au/)'s [Cookbook repository](https://github.com/COSIMA/cosima-recipes) that holds recipes for analysing ocean-sea ice model output.
 
+
+
+## Citation
+
+If you use a recipe from the Cookbook for your research or teaching, or have based your analysis on one of the recipes, we would be grateful if you could cite:
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14503323.svg)](https://doi.org/10.5281/zenodo.14503323)
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -36,16 +36,23 @@ Happy cooking! 😉 🥙 🍱 🍲
    GitHub Repository <https://github.com/ACCESS-Community-Hub/atmosphere-cookbook>
 
 
-Search
-+++++++
-
-* :ref:`search`
-
-
 Credits
 +++++++
 
 The structure and content of this repository draws inspiration from the
 `Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA) <http://cosima.org.au/>`_'s
 `Cookbook repository <https://github.com/COSIMA/cosima-recipes>`_ that holds recipes for
 analysing ocean-sea ice model output.
+
+Citation
+++++++++
+
+If you use a recipe from the Cookbook for your research or teaching, or have based your analysis on one of the recipes, we would be grateful if you could cite:
+
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14503323.svg
+  :target: https://doi.org/10.5281/zenodo.14503323
+
+Search
++++++++
+
+* :ref:`search`