Skip to content

Commit 6bce4a8

Browse files
committed
Update 2.5 docs
1 parent efb5eec commit 6bce4a8

File tree

5 files changed

+97
-90
lines changed

5 files changed

+97
-90
lines changed

CHANGELOG.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,11 @@ to account for pelvis segment morphing into leg pelvis coordinate system using
173173
* Add an option to override the default kinematic joint limits in the MoCap
174174
framework
175175

176-
177-
## AMMR 2.4.4
176+
(ammr-2.4-changelog)=
177+
## AMMR 2.4.4 (2023-04-03)
178178
[![Zenodo link](https://zenodo.org/badge/DOI/10.5281/zenodo.7764841.svg)](https://doi.org/10.5281/zenodo.7764841)
179+
[![AnyBody link](https://img.shields.io/badge/Included_with_AnyBody-7.4.4-yellowgreen)](https://www.anybodytech.com/download/anybodysetup-7-4-4-8907_x64/)
180+
179181

180182
This version of AMMR adds a number fixes and tweaks to the body models which
181183
improves robustness of various kinematic and recruitment solvers.
@@ -201,7 +203,6 @@ improves robustness of various kinematic and recruitment solvers.
201203
* Corrected small asymmetry in function for nonlinear intervertebral disc stiffness in coronal plane (affects only those who used polynomial disc stiffness).
202204

203205

204-
(ammr-2.4-changelog)=
205206
## AMMR 2.4.3 (2023-01-27)
206207
[![Zenodo link](https://zenodo.org/badge/DOI/10.5281/zenodo.7572879.svg)](https://doi.org/10.5281/zenodo.7572879) [![AnyBody link](https://img.shields.io/badge/Included_with_AnyBody-7.4.3-yellowgreen)](https://www.anybodytech.com/download/anybodysetup-7-4-3-8899_x64/)
207208

Docs/about.md

+73-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# The AnyBody Managed Model Repository (AMMR)
1+
# About the AnyBody Model Repository
2+
3+
## Cite
24

35
The AnyBody Managed Model Repository has a DOI {{ DOI }}. This is handled by [Zenodo.org](https://zenodo.org/), which is an European Open Science platform hosted at CERN.
46
You can download all archived versions of the AMMR from [Zenodo.org](https://doi.org/10.5281/zenodo.1250764).
@@ -16,11 +18,75 @@ Lund, Morten Enemark, Tørholm, Søren, et al. (2023, Jan 29). The AnyBody Manag
1618
:::
1719

1820

21+
## Contribute
22+
23+
The Model Repository is the product of collaboration between AnyBody Technology,
24+
and many academic institutions and research projects.
25+
26+
If you are interested in beta models/repositories you can get access to the
27+
development version of the AMMR. Development takes place in a semi-closed
28+
repository. The repository is closed to protect academic contributors who also
29+
often need to publish their models before release.
30+
31+
However, access is given on request. Please [submit an issue here](https://github.com/AnyBody/ammr-doc/issues), to request access.
32+
33+
You can also view other freely available models and resources hosted on [GitHub](https://github.com/anybody).
34+
35+
:::{only} draft
36+
::::{dropdown} Release checklist
37+
38+
1. Update `AMMR.version.any`.
39+
40+
- Update with the new version numbers
41+
42+
- Fill the `ANYBODY_HASH_BODY`. The new value can be found in `Main.HumanModel.Config.HashBodyModel`.
43+
44+
2. Update any AMS version number in `Docs/conf.py` (only used when building locally)
45+
46+
3. Create new version of AMMR on Zenodo (<https://zenodo.org/record/3404750).
47+
48+
- Click `New version` button
49+
50+
- Fill the neccessary fields. Authors are those who contributed since last Release
51+
52+
- Note the draft DOI which zenodo reserves
53+
54+
- Save the draft but do **not** publish it.
55+
56+
4. Clean up, and update `Docs/changelog.rst`
57+
58+
- Prof read and check that all changes are documented.
59+
60+
- Add Zenodo DOI url to the new release, and fill the date
61+
62+
5. Check that the docs can build, and that the tests pass.
63+
64+
6. Merge the branch and add a git tag.
65+
66+
7. Upload ammr zip file to Zenodo
67+
68+
- Either use the AMMR zip file created by the AMS build. This (it con or create a
69+
70+
**released zip file by running:**
71+
72+
```
73+
cd Docs
74+
make release
75+
mv release.zip ammr-X.Y.Z.zip
76+
```
77+
78+
This creates a zip file with the built documentation.
79+
80+
- Edit the draft Zenodo release to upload a zip file with AMMR.
81+
82+
::::
83+
:::
84+
85+
86+
87+
88+
89+
90+
1991
20-
```{toctree}
21-
:maxdepth: 1
2292
23-
changelog
24-
contribute
25-
legal
26-
```

Docs/contribute.md

-65
This file was deleted.

Docs/environment.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ channels:
44
dependencies:
55
- python=3.11
66
- pip
7-
- sphinx<6
7+
- sphinx
88
- pydata-sphinx-theme>=0.13.0
99
- make
1010
- myst-parser

Docs/index.md

+19-14
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ The AnyBody Model Repository (AMMR), is an unique open library of
5656
musculoskeletal models and examples ready to be used with the [AnyBody Modeling
5757
System][anybody modeling system]. The AnyBody Managed Model Repository consists of two parts:
5858
59+
60+
```{admonition} **First time user?**
61+
:class: hint dropdown margin
62+
63+
If you are a new user check the [AnyBody Tutorials](https://anyscript.org/tutorials/) and the getting started video on AnyBody.
64+
65+
The following {doc}`Getting Started section </getting_started>` on the AMMR provides insight into how AMMR is structured, how to
66+
install it and how to use it.
67+
```
68+
5969
<span class="material-symbols-outlined">
6070
</span>
6171

@@ -70,7 +80,7 @@ System][anybody modeling system]. The AnyBody Managed Model Repository consists
7080
The human body models which can be
7181
customized and scaled to build a specific musculoskeletal model.
7282
+++
73-
{ref}`Learn more » <the-body-model>`
83+
{ref}`Learn more » <the-body-model>`
7484
:::
7585

7686
:::{grid-item-card} {material-regular}`fitness_center;2em` Example gallery
@@ -79,7 +89,7 @@ customized and scaled to build a specific musculoskeletal model.
7989

8090
Lots of applicaiton examples showing how the body models are used.
8191
+++
82-
{ref}`Learn more » <example-gallery>`
92+
{ref}`Learn more » <example-gallery>`
8393
:::
8494

8595
:::{grid-item-card} {material-regular}`settings;2em` Model Configuration
@@ -88,27 +98,21 @@ Lots of applicaiton examples showing how the body models are used.
8898

8999
Information on how to configure the body models, and enable or disable various body parts.
90100
+++
91-
{ref}`Learn more » <bm-config>`
101+
{ref}`Learn more » <bm-config>`
92102
:::
93103

94104
::::
95105

96106

97107

108+
109+
98110
The models are developed in research projects at academic institutions or by
99111
AnyBody Technology in collaboration with academic institutions. The models are
100112
maintained by AnyBody Technology who ensure that various body part models can be
101113
used together as a full body, scalable musculoskeletal model.
102114

103115

104-
```{admonition} **First time user?**
105-
:class: hint dropdown
106-
107-
If you are a new user check the [AnyBody Tutorials](https://anyscript.org/tutorials/) and the getting started video on AnyBody.
108-
109-
The following {doc}`Getting Started section </getting_started>` on the AMMR provides insight into how AMMR is structured, how to
110-
install it and how to use it.
111-
```
112116

113117
[anybody modeling system]: https://www.anybodytech.com/software/anybodymodelingsystem/
114118

@@ -153,14 +157,15 @@ anymocap/index
153157

154158

155159
```{toctree}
156-
:caption: ????????
160+
:caption: About
157161
:includehidden: true
158162
:hidden: true
159163
:maxdepth: 2
160164
:titlesonly: true
161165
162166
163-
164-
About the model repository <about>
167+
changelog
168+
Contribute or cite <about>
169+
legal
165170
166171
```

0 commit comments

Comments
 (0)