a b/Docs/about.md
1
# About the AnyBody Model Repository
2
3
## Cite 
4
5
The AnyBody Managed Model Repository has a DOI {{ DOI }}. This is handled by
6
[Zenodo.org](https://zenodo.org/), which is an European Open Science platform
7
hosted at CERN. You can download all archived versions of the AMMR from
8
[Zenodo.org](https://doi.org/10.5281/zenodo.1250764).
9
10
You can download all archived versions of the AMMR from
11
[Zenodo.org](https://doi.org/10.5281/zenodo.1250764). The DOI is useful when
12
citing the a specific version of the AMMR. For example, when citing the AMMR
13
2.4.3:
14
15
:::{note}
16
:class: margin
17
Remember to use the DOI for the specific version you use.
18
:::
19
20
:::{card} {material-regular}`format_quote;2em;` Citation
21
Lund, Morten Enemark, Tørholm, Søren, et al. (2023, Jan 29). The AnyBody Managed 
22
Model Repository (AMMR) (Version 2.4.3). Zenodo. <https://doi.org/10.5281/zenodo.7572879>
23
:::
24
25
26
## Contribute
27
28
The Model Repository is the product of collaboration between AnyBody Technology,
29
and many academic institutions and research projects. Development happens on GitHub
30
where you can follow the development and contribute to the models.
31
32
All contributions are welcome and greatly appreciated. If you find a bug or have 
33
comments to the code please report it on the [AnyScript forum](https://forum.anyscript.org).
34
35
If you have a fix or an improvement to the models we are happy to accept it. Code contributions and 
36
fixes are submitted on GitHub. 
37
38
Simply fork this repository, editor your fork and [start a pull
39
request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) 
40
41
42
43
:::{only} draft
44
::::{dropdown} Release checklist
45
46
1. Update `AMMR.version.any`.
47
48
   - Update with the new version numbers
49
50
   - Fill the `ANYBODY_HASH_BODY`. The new value can be found in `Main.HumanModel.Config.HashBodyModel`.
51
52
2. Update any  AMS version number in `Docs/conf.py` (only used when building locally)
53
54
3. Create new version of AMMR on Zenodo (<https://zenodo.org/record/3404750).
55
56
   - Click `New version` button
57
58
   - Fill the neccessary fields. Authors are those who contributed since last Release
59
60
   - Note the draft DOI which zenodo reserves
61
62
   - Save the draft but do **not** publish it.
63
64
4. Clean up, and update `Docs/changelog.rst`
65
66
   - Prof read and check that all changes are documented.
67
68
   - Add Zenodo DOI url to the new release, and fill the date
69
70
5. Check that the docs can build, and that the tests pass.
71
72
6. Merge the branch and add a git tag.
73
74
7. Upload ammr zip file to Zenodo
75
76
   - Either use the AMMR zip file created by the AMS build. This  (it con or create a
77
78
     **released zip file by running:**
79
80
     ```
81
     cd Docs
82
     make release
83
     mv release.zip ammr-X.Y.Z.zip
84
     ```
85
86
     This creates a zip file with the built documentation.
87
88
   - Edit the draft Zenodo release to upload a zip file with AMMR.
89
90
::::
91
:::
92
93
94
95
96
97
98
99
100