From 484adb8d9b1ca80a86e07c73a5c592d542f51deb Mon Sep 17 00:00:00 2001 From: "Andrew S. Rosen" Date: Sun, 7 Jan 2024 13:01:51 -0800 Subject: [PATCH] Add JOSS paper to README and docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 4248bfce..ab241e5a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![code coverage](https://img.shields.io/codecov/c/gh/materialsproject/jobflow/main)](https://codecov.io/gh/materialsproject/jobflow/) [![pypi version](https://img.shields.io/pypi/v/jobflow?color=blue)](https://pypi.org/project/jobflow/) ![supported python versions](https://img.shields.io/pypi/pyversions/jobflow) +[![DOI](https://joss.theoj.org/papers/10.21105/joss.05995/status.svg)](https://doi.org/10.21105/joss.05995) [Documentation](https://materialsproject.github.io/jobflow/) | [PyPI](https://pypi.org/project/jobflow/) | [GitHub](https://github.com/materialsproject/jobflow) @@ -110,6 +111,12 @@ We maintain a list of all contributors [here][contributors]. jobflow is released under a modified BSD license; the full text can be found [here][license]. +## Citation + +If you use Jobflow in your work, please cite it as follows: + +- "Jobflow: Computational Workflows Made Simple", A.S. Rosen, M. Gallant, J. George, J. Riebesell, H. Sahasrabuddhe, J.X. Shen, M. Wen, M.L. Evans, G. Petretto, D. Waroquiers, G.‑M. Rignanese, K.A. Persson, A. Jain, A.M. Ganose, _Journal of Open Source Software_, 9(93), 5995 (2024). + ## Acknowledgements Jobflow was designed by Alex Ganose, Anubhav Jain, Gian-Marco Rignanese, David Waroquiers, and Guido Petretto. Alex Ganose implemented the first version of the package. Later versions have benefited from the contributions of several research groups. A full list of contributors is available [here](https://materialsproject.github.io/jobflow/contributors.html).