diff --git a/README.md b/README.md index 3695acc..264fb16 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,8 @@ or `conda`: Our [documentation](https://lammpsio.readthedocs.io) includes installation, examples, and commands. + +## Citing lammpsio + +When using `lammpsio` in published work, please cite: +> C. L. Petix, M. Kundu, and M. P. Howard, "lammpsio: Transparent and reproducible handling of LAMMPS particle data in Python." Journal of Open Source Software 10, 8962 (2025); [doi:10.21105/joss.08962](https://doi.org/10.21105/joss.08962). diff --git a/doc/source/citing.rst b/doc/source/citing.rst new file mode 100644 index 0000000..26901ed --- /dev/null +++ b/doc/source/citing.rst @@ -0,0 +1,9 @@ +============ +How to Cite +============ + +When using ``lammpsio`` in published work, please cite: + + C. L. Petix, M. Kundu, and M. P. Howard, "lammpsio: Transparent and + reproducible handling of LAMMPS particle data in Python." *Journal of Open Source + Software* **10**, 8962 (2025); `doi:10.21105/joss.08962 `_. diff --git a/doc/source/index.rst b/doc/source/index.rst index a5e7514..8c2719e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -26,5 +26,6 @@ in a variety of ways that improve workflow efficiency and reproducibility. :maxdepth: 1 :caption: Additional information + ./citing ./credits ./license