update citation guidelines with JOSS article

AStcherbinine · Jul 20, 2024 · 1ff0377 · 1ff0377
1 parent adbc596
commit 1ff0377
Showing 1 changed file with 54 additions and 16 deletions.
diff --git a/docs/credits.md b/docs/credits.md
@@ -16,19 +16,57 @@ CNRS, Toulouse, France
 This package is released under a MIT open source license. See [`LICENSE`](https://github.com/AStcherbinine/omegapy/blob/master/LICENSE) for more details.
 
 ## Citing OMEGA-Py
-If you are using OMEGA-Py in your research, please cite it with:  
-Stcherbinine, Aurélien. (2023). OMEGA-Py: Python tools for OMEGA data (v3.0). *Zenodo*. [doi:10.5281/zenodo.10035061](https://doi.org/10.5281/zenodo.10035061)
-
-BibTeX entry:
-~~~bibtex
-@software{omegapy_v3-0,
-  author       = {Stcherbinine, Aurélien},
-  title        = {OMEGA-Py: Python tools for OMEGA data},
-  month        = oct,
-  year         = 2023,
-  publisher    = {Zenodo},
-  version      = {v3.0},
-  doi          = {10.5281/zenodo.10035061},
-  url          = {https://doi.org/10.5281/zenodo.10035061}
-}
-~~~
+If you are using OMEGA-Py in your research, please cite it with our article in the Journal of Open
+Source Software and the Zenodo archive repository of the source code.
+
+### JOSS article
+A. Stcherbinine, Y. Langevin, J. Carter, M. Vincendon, Y. Leseigneur, O. Barraud (2024). 
+OMEGA-Py: Python Tools for OMEGA data. *Journal of Open Source Software, 9(99)*, 6566. 
+[doi:10.21105/joss.06566](https://doi.org/10.21105/joss.06566)
+
+!!! note "BibTeX entry"
+    ~~~bibtex
+    @article{omegapy_joss,
+    author       = {Stcherbinine, Aurélien and
+                    Langevin, Yves and
+                    Carter, John and
+                    Vincendon, Mathieu and
+                    Leseigneur, Yann and
+                    Barraud, Océane},
+    title        = {OMEGA-Py: Python Tools for OMEGA Data}, 
+    journal      = {Journal of Open Source Software},
+    doi          = {10.21105/joss.06566}, 
+    year         = 2024, 
+    month        = jul,
+    volume       = {9}, 
+    number       = {99}, 
+    pages        = {6566}, 
+    publisher    = {The Open Journal}, 
+    url          = {https://doi.org/10.21105/joss.06566}, 
+    }
+    ~~~
+
+### Zenodo archive repository
+A. Stcherbinine, Y. Langevin, J. Carter, M. Vincendon, Y. Leseigneur, O. Barraud (2024). 
+OMEGA-Py: Python Tools for OMEGA data (v3.1). *Zenodo*. 
+[doi:10.5281/zenodo.12775561](https://doi.org/10.5281/zenodo.12775561)
+
+!!! note "BibTeX entry"
+    ~~~bibtex
+    @software{omegapy_v3-1,
+    author       = {Stcherbinine, Aurélien and
+                    Langevin, Yves and
+                    Carter, John and
+                    Vincendon, Mathieu and
+                    Leseigneur, Yann and
+                    Barraud, Océane},
+    title        = {OMEGA-Py: Python Tools for OMEGA data},
+    year         = 2024,
+    month        = jul,
+    publisher    = {Zenodo},
+    version      = {v3.1},
+    doi          = {10.5281/zenodo.12775561},
+    url          = {https://doi.org/10.5281/zenodo.12775561}
+    }
+    ~~~
+