From a0dc2b4c006cadcd01dd0d5885269cd5e298197d Mon Sep 17 00:00:00 2001 From: clpetix Date: Mon, 22 Dec 2025 11:39:04 -0600 Subject: [PATCH 1/3] Add citation information to doc and README. --- README.md | 5 +++++ doc/source/index.rst | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index 3695acc7..07ff2d4a 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(116), 8962 (2025). [doi:10.21105/joss.08962](https://doi.org/10.21105/joss.08962) diff --git a/doc/source/index.rst b/doc/source/index.rst index a5e75141..dec386d7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,3 +28,11 @@ in a variety of ways that improve workflow efficiency and reproducibility. ./credits ./license + +.. rubric:: 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(116)**, 8962 (2025). `doi:10.21105/joss.08962 `_ From b0a0a0e342d351ded8ae68fa49baa862d57b128b Mon Sep 17 00:00:00 2001 From: clpetix Date: Mon, 5 Jan 2026 14:06:49 -0600 Subject: [PATCH 2/3] Add citation section to documentation --- doc/source/citing.rst | 9 +++++++++ doc/source/index.rst | 9 +-------- 2 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 doc/source/citing.rst diff --git a/doc/source/citing.rst b/doc/source/citing.rst new file mode 100644 index 00000000..f78a17eb --- /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(116)**, 8962 (2025). `doi:10.21105/joss.08962 `_ diff --git a/doc/source/index.rst b/doc/source/index.rst index dec386d7..fdae1674 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,11 +28,4 @@ in a variety of ways that improve workflow efficiency and reproducibility. ./credits ./license - -.. rubric:: 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(116)**, 8962 (2025). `doi:10.21105/joss.08962 `_ + ./citing From b0c3425da1d614f1a7a506ec988e6f67909e6ef9 Mon Sep 17 00:00:00 2001 From: Levi Petix <81758680+clpetix@users.noreply.github.com> Date: Mon, 5 Jan 2026 14:41:55 -0600 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Michael Howard --- README.md | 2 +- doc/source/citing.rst | 6 +++--- doc/source/index.rst | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 07ff2d4a..264fb16b 100644 --- a/README.md +++ b/README.md @@ -23,4 +23,4 @@ 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(116), 8962 (2025). [doi:10.21105/joss.08962](https://doi.org/10.21105/joss.08962) +> 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 index f78a17eb..26901ed1 100644 --- a/doc/source/citing.rst +++ b/doc/source/citing.rst @@ -4,6 +4,6 @@ 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(116)**, 8962 (2025). `doi:10.21105/joss.08962 `_ + 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 fdae1674..8c2719e3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -26,6 +26,6 @@ in a variety of ways that improve workflow efficiency and reproducibility. :maxdepth: 1 :caption: Additional information + ./citing ./credits ./license - ./citing