Skip to content

Commit

Permalink
Add how to cite to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vadmbertr authored Oct 3, 2024
1 parent 26628d9 commit d6f8a7f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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!

0 comments on commit d6f8a7f

Please sign in to comment.