Skip to content

Add citation information to doc and README #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clpetix wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add citation information to doc and README #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
8 changes: 8 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://doi.org/10.21105/joss.08962>`_