Merge pull request #85 from vadmbertr/vadmbertr-issue76

Vadmbertr issue76

CITATION.cff

@@ -0,0 +1,16 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: "Bertrand"
+    given-names: "Vadim"
+  - family-names: "E V Z De Almeida"
+    given-names: "Victor"
+  - family-names: "Le Sommer"
+    given-names: "Julien"
+  - family-names: "Cosme"
+    given-names: "Emmanuel"
+title: "jaxparrow"
+version: 0.2.2
+doi: 10.5281/zenodo.8010997
+date-released: 2024-08-23
+url: "https://github.com/meom-group/jaxparrow"

README.md

@@ -4,6 +4,7 @@
 [![PyPi](https://img.shields.io/badge/dynamic/xml?url=https://pypi.org/rss/project/jaxparrow/releases.xml&label=PyPi&query=/rss/channel/item[1]/title)](https://pypi.org/project/jaxparrow/)
 ![Tests](https://github.com/meom-group/jaxparrow/actions/workflows/python-package.yml/badge.svg)
 [![Docs](https://github.com/meom-group/jaxparrow/actions/workflows/python-documentation.yml/badge.svg)](https://jaxparrow.readthedocs.io/)
+[![DOI](https://zenodo.org/badge/702998298.svg)](https://doi.org/10.5281/zenodo.13886071)
 
 `jaxparrow` implements a novel approach based on a variational formulation to compute the inversion of the cyclogeostrophic balance.
 
@@ -80,3 +81,8 @@ An example configuration file detailing all the required and optional entries ca
 
 Contributions of all sorts are welcomed!
 See [CONTRIBUTING.md](CONTRIBUTING.md) and [CONDUCT.md](CONDUCT.md) to get started.
+
+## How to cite
+
+If you use this software, please cite it as specified in [CITATION.cff](CITATION.cff).
+Thank you!