Skip to content

Commit bde3852

Browse files
committed
added published paper citation
- updated README - add citation page to docs - add preferred citation to CITATION.cff
1 parent f6c9551 commit bde3852

4 files changed

Lines changed: 87 additions & 3 deletions

File tree

CITATION.cff

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
cff-version: 1.2.0
55
title: 'Zarrtraj: A Python package for streaming molecular dynamics trajectories from cloud services'
66
message: >-
7-
If you use this software, please cite it using the
8-
metadata from this file.
7+
If you use this software, please cite the JOSS paper listed
8+
under preferred-citation.
99
type: software
1010
authors:
1111
- given-names: Lawson
@@ -65,3 +65,35 @@ keywords:
6565
- mdanalysis
6666
- zarr
6767
license: MIT
68+
preferred-citation:
69+
type: article
70+
title: >-
71+
Zarrtraj: A Python package for streaming molecular dynamics
72+
trajectories from cloud services
73+
authors:
74+
- given-names: Lawson
75+
family-names: Woods
76+
orcid: 'https://orcid.org/0009-0003-0713-4167'
77+
- given-names: Hugo
78+
family-names: MacDermott-Opeskin
79+
orcid: 'https://orcid.org/0000-0002-7393-7457'
80+
- given-names: Edis
81+
family-names: Jakupovic
82+
orcid: 'https://orcid.org/0000-0001-8813-6356'
83+
- given-names: Yuxuan
84+
family-names: Zhuang
85+
orcid: 'https://orcid.org/0000-0003-4390-8556'
86+
- given-names: Richard
87+
family-names: Gowers
88+
name-particle: J
89+
orcid: 'https://orcid.org/0000-0002-3241-1846'
90+
- given-names: Oliver
91+
family-names: Beckstein
92+
orcid: 'https://orcid.org/0000-0003-1340-0831'
93+
journal: Journal of Open Source Software
94+
year: 2026
95+
volume: 11
96+
issue: 121
97+
start: 7943
98+
doi: 10.21105/joss.07943
99+
url: 'https://doi.org/10.21105/joss.07943'

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,28 @@ and is available under the MIT License (see the file [LICENSE](https://github.co
4545

4646
Copyright (c) 2024, Lawson Woods
4747

48+
### Citation
49+
50+
If you use Zarrtraj in published work, please cite:
51+
52+
> Lawson Woods, Hugo MacDermott-Opeskin, Edis Jakupovic, Yuxuan Zhuang, Richard J Gowers, and Oliver Beckstein. (2026). Zarrtraj: A Python package for streaming molecular dynamics trajectories from cloud services. Journal of Open Source Software, 11(121), 7943, https://doi.org/10.21105/joss.07943
53+
54+
```bibtex
55+
@article{Woods2026zarrtraj,
56+
author = {Woods, Lawson and MacDermott-Opeskin, Hugo and Jakupovic, Edis and Zhuang, Yuxuan and Gowers, Richard J and Beckstein, Oliver},
57+
title = {Zarrtraj: A Python package for streaming molecular dynamics trajectories from cloud services},
58+
journal = {Journal of Open Source Software},
59+
year = {2026},
60+
volume = {11},
61+
number = {121},
62+
pages = {7943},
63+
doi = {10.21105/joss.07943},
64+
url = {https://doi.org/10.21105/joss.07943}
65+
}
66+
```
4867

4968
#### Acknowledgements
5069

5170
Project based on the
5271
[MDAnalysis Cookiecutter](https://github.com/MDAnalysis/cookiecutter-mda) version 0.1.
53-
Please cite [MDAnalysis](https://github.com/MDAnalysis/mdanalysis#citation) when using Zarrtraj in published work.
72+
Please also cite [MDAnalysis](https://www.mdanalysis.org/citations/#mdanalysis-library) when using Zarrtraj in published work.

docs/source/citation.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Citation
2+
========
3+
4+
If you use Zarrtraj in published work, please cite our JOSS paper:
5+
6+
.. code-block:: none
7+
8+
Lawson Woods, Hugo MacDermott-Opeskin, Edis Jakupovic, Yuxuan Zhuang, Richard J Gowers, and Oliver Beckstein. (2026). Zarrtraj: A Python package for streaming molecular dynamics trajectories from cloud services. Journal of Open Source Software, 11(121), 7943, https://doi.org/10.21105/joss.07943
9+
10+
BibTeX
11+
------
12+
13+
.. code-block:: bibtex
14+
15+
@article{Woods2026zarrtraj,
16+
author = {Woods, Lawson and MacDermott-Opeskin, Hugo and Jakupovic, Edis and Zhuang, Yuxuan and Gowers, Richard J and Beckstein, Oliver},
17+
title = {Zarrtraj: A Python package for streaming molecular dynamics trajectories from cloud services},
18+
journal = {Journal of Open Source Software},
19+
year = {2026},
20+
volume = {11},
21+
number = {121},
22+
pages = {7943},
23+
doi = {10.21105/joss.07943},
24+
url = {https://doi.org/10.21105/joss.07943}
25+
}
26+
27+
Acknowledgements
28+
----------------
29+
30+
Zarrtraj is an `MDAnalysis MDAKit <https://mdakits.mdanalysis.org>`__.
31+
Please also cite `MDAnalysis <https://www.mdanalysis.org/citations/#mdanalysis-library>`__
32+
when using Zarrtraj in published work.

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ This means users can interact with massive trajectory files without ever storing
2222
performance_considerations
2323
zarrmd-file-spec/v0.2.0
2424
benchmarks
25+
citation
2526

0 commit comments

Comments
 (0)