Skip to content

Commit 8b904c6

Browse files
authored
Update zenodo information and links (#785)
* Update zenodo information and links * Backport fix to BM table links * Update changelog * Proff read text on landing page
1 parent 528cf76 commit 8b904c6

File tree

13 files changed

+136
-135
lines changed

13 files changed

+136
-135
lines changed

Body/AAUHuman/BodyModels/GenericBodyModel/undef_BM_params.any

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@
446446
#ifdef BM_GLOBAL_REFERENCE_FRAME
447447
#undef BM_GLOBAL_REFERENCE_FRAME
448448
#endif
449-
449+
450450
#ifdef _BM_PELVIS_DISPLAY_
451451
#undef _BM_PELVIS_DISPLAY_
452452
#endif
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{% for name, data in data.items() -%}
2-
'{{name}}', '{{data.descr|replace("'", '"')}}'
2+
'{any}`{{name}}`', '{{data.descr|replace("'", '"')}}'
33
{% endfor -%}

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ improves robustness of various kinematic and recruitment solvers.
1717
joint where marker tracking solver would occasional find a local minima with
1818
unphysiological posture.
1919

20+
* Tables with body model configuration parameter in the AMMR documentation now contains
21+
links showing their options. See for example the page on {doc}`Leg model parameter </bm_config/leg>`.
2022

2123
**Fixed:**
22-
Thank you for sharing these entries with me. Here are some revised versions:
2324

2425
* Fixed an issue with wrist joint segment's load time position (start guess). This greatly improves kinematic robustness of all models with arms as it creates a 'universal-joint' mechanism for wrist movement.
2526

Docs/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The AnyBody Managed Model Repository now has a DOI {{ DOI }}.
44

55
This is handled by [Zenodo.org](https://zenodo.org/), which is an European Open Science platform hosted at CERN.
6-
You can download all archived versions of the AMMR from [Zenodo.org](https://doi.org/10.5281/zenodo.1250764/).
6+
You can download all archived versions of the AMMR from [Zenodo.org](https://doi.org/10.5281/zenodo.1250764).
77

88
The DOI is also usefull when citing the AMMR. For example, when citing the AMMR 2.4.3:
99

Docs/bm_config/ArmTable.csv

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
'BM_ARM_THORAX_SCAPULA_CONTACT', 'Parameter defining the contact type between Thorax and Scapula'
2-
'BM_ARM_STRENGTH_INDEX', 'Index parameter to specify muscle strength for upper extremities.'
3-
'BM_ARM_LEFT', 'Switch for the left arm model being present or not.'
4-
'BM_ARM_DETAIL_HAND_LEFT', 'Keyword for the type of left hand.'
5-
'BM_ARM_SHOULDER_RHYTHM_LEFT', 'Switch for the shoulder rhythm constraints for the left arm being present or not.'
6-
'BM_ARM_RIGHT', 'Switch for the right arm model being present or not.'
7-
'BM_ARM_DETAIL_HAND_RIGHT', 'Keyword for the type of right hand.'
8-
'BM_ARM_SHOULDER_RHYTHM_RIGHT', 'Switch for the shoulder rhythm constraints for the right arm being present or not.'
9-
'BM_ARM_SHOULDER_RHYTHM', 'Switch for the shoulder rhythm constraints. ON indicate that the rhythm is a hard contraint while _RHYTHM_SOFT_ will make the rhythm as soft kinematic contraint.'
10-
'BM_ARM_CLAVICULA_ROTATION_RHYTHM', 'Switch for the clavicula rotation rhythm. If enabled axial rotation of the clavicula will be distributed evenly between the sterno-clavicula and acromio-clavicula joint. Effectively removing clavicula axial rotation as an independent degree of freedom.resterno-clavicula axial rotation.'
11-
'BM_ARM_DETAILED_HAND', 'Switch for enabling the detailed hand.'
12-
'BM_ARM_DELTOID_WRAPPING', 'Switch for deltoid wrapping. Setting this to OFF or _DELTOID_WRAPPING_RAKE_ will revert to the older rake based implementation of the deltoid.'
13-
'BM_ARM_MUSCLES_BOTH', 'Keyword for the muscle model type for both left and right arms.'
14-
'BM_ARM_MUSCLES_LEFT', 'Keyword for the muscle model type for the left arm.'
15-
'BM_ARM_MUSCLES_RIGHT', 'Keyword for the muscle model for both the right arm.'
1+
'{any}`BM_ARM_THORAX_SCAPULA_CONTACT`', 'Parameter defining the contact type between Thorax and Scapula'
2+
'{any}`BM_ARM_STRENGTH_INDEX`', 'Index parameter to specify muscle strength for upper extremities.'
3+
'{any}`BM_ARM_LEFT`', 'Switch for the left arm model being present or not.'
4+
'{any}`BM_ARM_DETAIL_HAND_LEFT`', 'Keyword for the type of left hand.'
5+
'{any}`BM_ARM_SHOULDER_RHYTHM_LEFT`', 'Switch for the shoulder rhythm constraints for the left arm being present or not.'
6+
'{any}`BM_ARM_RIGHT`', 'Switch for the right arm model being present or not.'
7+
'{any}`BM_ARM_DETAIL_HAND_RIGHT`', 'Keyword for the type of right hand.'
8+
'{any}`BM_ARM_SHOULDER_RHYTHM_RIGHT`', 'Switch for the shoulder rhythm constraints for the right arm being present or not.'
9+
'{any}`BM_ARM_SHOULDER_RHYTHM`', 'Switch for the shoulder rhythm constraints. ON indicate that the rhythm is a hard contraint while _RHYTHM_SOFT_ will make the rhythm as soft kinematic contraint.'
10+
'{any}`BM_ARM_CLAVICULA_ROTATION_RHYTHM`', 'Switch for the clavicula rotation rhythm. If enabled axial rotation of the clavicula will be distributed evenly between the sterno-clavicula and acromio-clavicula joint. Effectively removing clavicula axial rotation as an independent degree of freedom.resterno-clavicula axial rotation.'
11+
'{any}`BM_ARM_DETAILED_HAND`', 'Switch for enabling the detailed hand.'
12+
'{any}`BM_ARM_DELTOID_WRAPPING`', 'Switch for deltoid wrapping. Setting this to OFF or _DELTOID_WRAPPING_RAKE_ will revert to the older rake based implementation of the deltoid.'
13+
'{any}`BM_ARM_MUSCLES_BOTH`', 'Keyword for the muscle model type for both left and right arms.'
14+
'{any}`BM_ARM_MUSCLES_LEFT`', 'Keyword for the muscle model type for the left arm.'
15+
'{any}`BM_ARM_MUSCLES_RIGHT`', 'Keyword for the muscle model for both the right arm.'

Docs/bm_config/JointTypeTable.csv

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
'BM_JOINT_TYPE_HIP_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
2-
'BM_JOINT_TYPE_HIP_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
3-
'BM_JOINT_TYPE_KNEE_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
4-
'BM_JOINT_TYPE_KNEE_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
5-
'BM_JOINT_TYPE_PATELLOFEMORAL_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
6-
'BM_JOINT_TYPE_PATELLOFEMORAL_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
7-
'BM_JOINT_TYPE_ANKLE_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
8-
'BM_JOINT_TYPE_ANKLE_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
9-
'BM_JOINT_TYPE_SUBTALAR_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
10-
'BM_JOINT_TYPE_SUBTALAR_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
11-
'BM_JOINT_TYPE_PATELLATENDON_RIGHT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
12-
'BM_JOINT_TYPE_PATELLATENDON_LEFT', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
1+
'{any}`BM_JOINT_TYPE_HIP_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
2+
'{any}`BM_JOINT_TYPE_HIP_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
3+
'{any}`BM_JOINT_TYPE_KNEE_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
4+
'{any}`BM_JOINT_TYPE_KNEE_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
5+
'{any}`BM_JOINT_TYPE_PATELLOFEMORAL_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
6+
'{any}`BM_JOINT_TYPE_PATELLOFEMORAL_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
7+
'{any}`BM_JOINT_TYPE_ANKLE_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
8+
'{any}`BM_JOINT_TYPE_ANKLE_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
9+
'{any}`BM_JOINT_TYPE_SUBTALAR_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
10+
'{any}`BM_JOINT_TYPE_SUBTALAR_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
11+
'{any}`BM_JOINT_TYPE_PATELLATENDON_RIGHT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'
12+
'{any}`BM_JOINT_TYPE_PATELLATENDON_LEFT`', 'Parameter for switching between different joint types. Can also be used to completely exclude the joint, which then must be re-implemented manually.'

Docs/bm_config/LegTable.csv

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
'BM_LEG_MODEL', 'Parameter defining the Leg model used.'
2-
'BM_LEG_LEFT', 'Parameter for switching the left leg On/Off. To control which leg model is used, please use the {any}`BM_LEG_MODEL` parameter.'
3-
'BM_LEG_RIGHT', 'Parameter for switching the right leg On/Off. To control which leg model is used, please use the {any}`BM_LEG_MODEL` parameter.'
4-
'BM_LEG_STRENGTH_INDEX', 'Index parameter to specify muscle strength for lower extremities'
5-
'BM_LEG_MUSCLES_BOTH', 'Parameter to define muscle behavior of both right and left leg'
6-
'BM_LEG_MUSCLES_LEFT', 'Parameter to define muscle behavior of the left leg'
7-
'BM_LEG_MUSCLES_RIGHT', 'Parameter to define muscle behavior of the right leg'
8-
'BM_LEG_DATASET', 'Path to specify the underlying dataset. This currently only affects the TLEM based models. Valid options depends on which model (TLEM1/2) is used, and what dataset are available. If not specified, this will be configure automatically.'
9-
'BM_LEG_TRUNK_INTERFACE', 'Keyword for the interface morhping between the trunk and the leg pelvis segments.'
1+
'{any}`BM_LEG_MODEL`', 'Parameter defining the Leg model used.'
2+
'{any}`BM_LEG_LEFT`', 'Parameter for switching the left leg On/Off. To control which leg model is used, please use the {any}`BM_LEG_MODEL` parameter.'
3+
'{any}`BM_LEG_RIGHT`', 'Parameter for switching the right leg On/Off. To control which leg model is used, please use the {any}`BM_LEG_MODEL` parameter.'
4+
'{any}`BM_LEG_STRENGTH_INDEX`', 'Index parameter to specify muscle strength for lower extremities'
5+
'{any}`BM_LEG_MUSCLES_BOTH`', 'Parameter to define muscle behavior of both right and left leg'
6+
'{any}`BM_LEG_MUSCLES_LEFT`', 'Parameter to define muscle behavior of the left leg'
7+
'{any}`BM_LEG_MUSCLES_RIGHT`', 'Parameter to define muscle behavior of the right leg'
8+
'{any}`BM_LEG_DATASET`', 'Path to specify the underlying dataset. This currently only affects the TLEM based models. Valid options depends on which model (TLEM1/2) is used, and what dataset are available. If not specified, this will be configure automatically.'
9+
'{any}`BM_LEG_TRUNK_INTERFACE`', 'Keyword for the interface morhping between the trunk and the leg pelvis segments.'

0 commit comments

Comments
 (0)