Skip to content

Commit 454a928

Browse files
replaced whitepaper with paper DOI in README (#167)
* replaced whitepaper with paper DOI in README - fix #87 - some more README clean-up --------- Co-authored-by: Fiona Naughton <fiona@mdanalysis.org>
1 parent 8007b59 commit 454a928

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

README.rst

+30-14
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,36 @@
88
Contents
99
========
1010

11-
This repository contains the source code for the MDAKits registry.
12-
The registry hosts a list of MDAKits which it then both documents
13-
and continually validate.
11+
This repository contains the source code for the `MDAKits registry`_.
1412

15-
For more details about the MDAKit registry, see Section 4 of the
16-
`MDAKit Whitepaper`_.
13+
The registry hosts a list of MDAKits which it then both documents and
14+
continually validates. For more details about the MDAKit registry, please see
15+
the `MDAKit paper`_ in the section *The MDAKit registry*.
16+
17+
For detailed documentation and tutorials about MDAKits see the MDAKits site
18+
https://mdakits.mdanalysis.org/
1719

1820

1921
Creating a new MDAKit
2022
=====================
2123

22-
The minimum specification for an MDAKit is defined under Section 3 of the
23-
`MDAKit Whitepaper`_. To developers in creating best practices adhering
24-
projects, a `cookiecutter`_ has been made available.
24+
The minimum specification for an MDAKit is defined in the `MDAKit
25+
paper`_ under *The MDAKit framework*. To developers in creating best
26+
practices adhering projects, a `cookiecutter`_ has been made
27+
available.
2528

2629

2730
Adding a new MDAKit
2831
===================
2932

30-
The registry is currently in development, the way by which new MDAKits
31-
are added is likely to change significantly over time. If you have any
32-
concerns or questions about the process, please reach out by raising an
33-
issue!
34-
3533
Adding a new MDAKit involves making a PR against
3634
this repository and adding a new `metadata`_ file within it's own
3735
respective directory under `mdakits`.
3836

37+
*The registry is currently in development, the way by which new MDAKits are
38+
added may change over time. If you have any concerns or questions about the
39+
process, please reach out by raising an issue!*
40+
3941

4042
License
4143
=======
@@ -48,9 +50,23 @@ Acknowledgements
4850

4951
The development of this repository is supported by a grant from the Chan Zuckerberg Initiative under an EOSS4 award.
5052

53+
References
54+
==========
55+
56+
1. Irfan Alibay, Lily Wang, Fiona Naughton, Ian Kenney, Jonathan Barnoud,
57+
Richard J Gowers, and Oliver Beckstein. **MDAKits: A framework for
58+
FAIR-compliant molecular simulation analysis.** In Meghann Agarwal, Chris
59+
Calloway, and Dillon Niederhut, editors, *Proceedings of the 22nd Python in
60+
Science Conference (SCIPY 2023)*, pages 76-84, Austin, TX, 2023. doi:
61+
`10.25080/gerudo-f2bc6f59-00a`_.
62+
63+
.. _`MDAKits registry`: https://mdakits.mdanalysis.org/mdakits.html
64+
5165
.. _`metadata`: mdakits/template/metadata.yaml
5266

53-
.. _`MDAKit Whitepaper`: paper/whitepaper/MDAKits_whitepaper.pdf
67+
.. _`MDAKit paper`: https://doi.org/10.25080/gerudo-f2bc6f59-00a
68+
69+
.. _`10.25080/gerudo-f2bc6f59-00a`: https://doi.org/10.25080/gerudo-f2bc6f59-00a
5470

5571
.. _`cookiecutter`: https://github.com/MDAnalysis/cookiecutter-mdakit
5672

0 commit comments

Comments
 (0)