Skip to content

Commit 5534ab9

Browse files
author
Lavu
committed
Add IMDv3 protocol citation placeholder and instructions
- Uncomment IMDv3 citation section in references.rst - Make citation visible in documentation - Add clear instructions for when paper is published - Include template format for final citation - Resolves #5094
1 parent 9fb8b0a commit 5534ab9

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

package/doc/sphinx/source/documentation_pages/references.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -229,16 +229,18 @@ If you use H5MD files using
229229
pp. 18 – 26, 2021. doi:`10.25080/majora-1b6fd038-005.
230230
<https://www.doi.org/10.25080/majora-1b6fd038-005>`_
231231
232-
.. comment::
233-
234-
If you use IMD capability with :mod:`MDAnalysis.coordinates.IMD.py`, please cite [IMDv3paper]_.
235-
236-
.. [IMDv3paper] Authors (YEAR).
237-
IMDv3 Manuscript Title.
238-
*Journal*, 185. doi:`insert-doi-here <https://doi.org/>`_
239-
240-
.. todo:: Fill in the final IMDv3 citation once the paper is published.
241-
See https://github.com/MDAnalysis/mdanalysis/issues/5094
232+
If you use IMD capability with :mod:`MDAnalysis.coordinates.IMD.py` to stream
233+
molecular dynamics simulation data via the IMDv3 protocol, please cite [IMDv3paper]_.
234+
235+
.. [IMDv3paper] TODO: Add IMDv3 protocol paper citation here.
236+
Once the IMDv3 protocol paper is published, replace this entry with the full citation.
237+
See https://github.com/MDAnalysis/mdanalysis/issues/5094 for details.
238+
239+
The citation should have the format:
240+
241+
Authors (YEAR).
242+
IMDv3 Protocol Paper Title.
243+
*Journal*, Volume(Issue), pages. doi:`DOI <https://doi.org/DOI>`_
242244
243245
.. _citations-using-duecredit:
244246

0 commit comments

Comments
 (0)