From 0ec9fc9cc6c7e751ddae3ef6d579ec1252c691f0 Mon Sep 17 00:00:00 2001 From: Thomas Reichenbach Date: Sun, 28 Jan 2024 23:23:57 +0100 Subject: [PATCH 1/2] DOC: add JOSS badge --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e7b225f9e..ba449c970 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -|Tests| |Wheels| +|Tests| |Wheels| |JOSS| Matscipy ======== @@ -114,3 +114,6 @@ Funding .. |Wheels| image:: https://github.com/libAtoms/matscipy/actions/workflows/wheels.yml/badge.svg :target: https://github.com/libAtoms/matscipy/actions/workflows/wheels.yml + +.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.05668/status.svg + :target: https://doi.org/10.21105/joss.05668 From 17c1bb133f76042325d084944e431be946f1a714 Mon Sep 17 00:00:00 2001 From: Thomas Reichenbach Date: Sun, 28 Jan 2024 23:39:55 +0100 Subject: [PATCH 2/2] DOC: add citation guide in README --- README.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.rst b/README.rst index ba449c970..e2dad3788 100644 --- a/README.rst +++ b/README.rst @@ -104,6 +104,24 @@ Optional packages: - **atomistica** - https://www.github.com/Atomistica/atomistica - **chemview** - https://github.com/gabrielelanaro/chemview +Citing matscipy +--------------- + +Please cite the following publication if you use matscipy:: + + @article{Grigorev2024, + author = {Grigorev, Petr and Frérot, Lucas and Birks, Fraser and Gola, Adrien and Golebiowski, Jacek and Grießer, Jan and Hörmann, Johannes L. and Klemenz, Andreas and Moras, Gianpietro and Nöhring, Wolfram G. and Oldenstaedt, Jonas A. and Patel, Punit and Reichenbach, Thomas and Rocke, Thomas and Shenoy, Lakshmi and Walter, Michael and Wengert, Simon and Zhang, Lei and Kermode, James R. and Pastewka, Lars}, + doi = {10.21105/joss.05668}, + journal = {Journal of Open Source Software}, + month = jan, + number = {93}, + pages = {5668}, + title = {{matscipy: materials science at the atomic scale with Python}}, + url = {https://joss.theoj.org/papers/10.21105/joss.05668}, + volume = {9}, + year = {2024} + } + Funding -------