8
8
Contents
9
9
========
10
10
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 `_.
14
12
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/
17
19
18
20
19
21
Creating a new MDAKit
20
22
=====================
21
23
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.
25
28
26
29
27
30
Adding a new MDAKit
28
31
===================
29
32
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
-
35
33
Adding a new MDAKit involves making a PR against
36
34
this repository and adding a new `metadata `_ file within it's own
37
35
respective directory under `mdakits `.
38
36
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
+
39
41
40
42
License
41
43
=======
@@ -48,9 +50,23 @@ Acknowledgements
48
50
49
51
The development of this repository is supported by a grant from the Chan Zuckerberg Initiative under an EOSS4 award.
50
52
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
+
51
65
.. _`metadata` : mdakits/template/metadata.yaml
52
66
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
54
70
55
71
.. _`cookiecutter` : https://github.com/MDAnalysis/cookiecutter-mdakit
56
72
0 commit comments