Updated changelog and versions in AMMR

AnyBody · Oct 11, 2024 · 71efaf3 · 71efaf3
1 parent a23e6d0
commit 71efaf3
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 37 deletions.
diff --git a/.github/workflows/test-self-hosted.yml b/.github/workflows/test-self-hosted.yml
@@ -11,7 +11,7 @@ on:
       custom-anybodycon-name:
           description: 'Name of the custom AnyBody version to use. (E.g. path on the I:\ drive)'
           required: false
-          default: 'AnyBody.7.5-CI-master.AnyBody.8.0.x/AnyBodyCon.exe'
+          default: 'AnyBody.8.1-CI-master.AnyBody.8.1.x/AnyBodyCon.exe'
       custom-pytest-arg:
           description: 'Specify which test to run. E.g. `Tests/test_example.any`. Default is entire test suite.'
           required: false

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,7 @@ on:
       custom-anybodycon-name:
           description: 'Name of the custom AnyBody version to use. (E.g. path on the I:\ drive)'
           required: false
-          default: 'AnyBody.7.5-CI-master.AnyBody.8.0.x/AnyBodyCon.exe'
+          default: 'AnyBody.8.0-CI-master.AnyBody.8.1.x/AnyBodyCon.exe'
       custom-pytest-arg:
           description: 'Specify which test to run. E.g. `Tests/test_example.any`. Default is entire test suite.'
           required: false

diff --git a/Application/Examples/FemoralTorsion/libdef.any b/Application/Examples/FemoralTorsion/libdef.any
@@ -2,6 +2,6 @@
 // Double click the following line for a guide:
 // #path HTML_DOC "<ANYBODY_PATH_INSTALLDIR>/AMMR/getting_started.html"
 // For example...
-//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 
 #include "../libdef.any"
diff --git a/Application/Examples/StandingModel/libdef.any b/Application/Examples/StandingModel/libdef.any
@@ -2,6 +2,6 @@
 // Double click the following line for a guide:
 // #path HTML_DOC "<ANYBODY_PATH_INSTALLDIR>/AMMR/getting_started.html"
 // For example...
-//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 
 #include "../libdef.any"
diff --git a/Application/Examples/StatisticalScalingPlugin/libdef.any b/Application/Examples/StatisticalScalingPlugin/libdef.any
@@ -2,6 +2,6 @@
 // Double click the following line for a guide:
 // #path HTML_DOC "<ANYBODY_PATH_INSTALLDIR>/AMMR/getting_started.html"
 // For example...
-//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+//#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 
 #include "../libdef.any"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,35 +3,39 @@
 % A rendered version of the CHANGELOG is avaible here:
 %    https://anyscript.org/ammr/beta/changelog.html
 
-(ammr-3.0.5-changelog)=
-## AMMR 3.0.5 (2024-??-??)
+(ammr-3.1.0-changelog)=
+## AMMR 3.1.0 (2024-??-??)
 
 ### ➕ Added:
-* Added a small class template, [`CreateCoMRefNode`](#Utilities.center-of-mass.createcomrefnode.createcomrefnode),
-  that can be used to create a reference node at the center of mass of a segment with its axes aligned with
-  the principal axes of inertia of the segment.
-* Added a `TRI(N)` helper code macros which creates a lower triangular (NxN) matrix.
-* Added a `TOTAL_POLYLINE_LENGTH(P)` helper code macro which calculates the total length of a polyline defined by a set of points.
+* Introduced a new class template,
+  [`CreateCoMRefNode`](#Utilities.center-of-mass.createcomrefnode.createcomrefnode),
+  for generating a reference node at the center of mass of a segment, aligned
+  with its principal axes of inertia.
+* Added the `TRI(N)` macro to create a lower triangular (NxN) matrix.
+* Added the `TOTAL_POLYLINE_LENGTH(P)` macro to compute the total length of a
+  polyline defined by a set of points.
 
 ### 🩹 Fixed:
-* Fixed an issue that prevented switching off drawing of marker arrows in CreateMarkerDriverClass in MoCap models. Updated the search string
-  used in `Main.ModelSetup.Views.All_MarkerArrows.Objects` to correctly pick up the arrow drawing objects.
-* Fixed an issue in the PelvisGround rotation drivers in the {ref}`Free Posture Static example<example_freeposture>`. The X and Z rotation drivers 
-  were mixed up.
+* Resolved an issue that prevented disabling the drawing of marker arrows in
+  `CreateMarkerDriverClass` within MoCap models. The search string in
+  `Main.ModelSetup.Views.All_MarkerArrows.Objects` has been updated to correctly
+  identify the arrow drawing objects.
+* Corrected the PelvisGround rotation drivers in the {ref}`Free Posture Static
+  example<example_freeposture>`. The X and Z rotation drivers were previously
+  mixed up and are now properly assigned.
 
 ### 🔧 Changed:
-* Updated the Gluteus Medius insertions and origin points, to ensure the muscles
-  have correct moment arm for external rotation in certain postures. The
-  posterior gluteus medius now twist inside the anterior part and attach more
-  anteriorly on the femural trochanter.
-* Changed the Human-Ground residual implmentation in the MoCap models to use
-  rotatinal measures configured for measuring angual velocities. This change
-  should make the resiuals more robust, and the residual output easier to
-  interpret geometrically. Otherwise, this should not change results. 
-* The Force plates are no longer included in the parameter identification study.
-  It wasn't needed, and this change may speed up the parameter identification
-  process slightly.
-
+* Updated the insertion and origin points of the Gluteus Medius to ensure
+  correct moment arms for external rotation in specific postures. The posterior
+  Gluteus Medius now twists inside the anterior part and attaches more
+  anteriorly on the femoral trochanter.
+* Modified the Human-Ground residual implementation in MoCap models to use
+  rotational measures configured for angular velocities. This change enhances
+  the robustness of the residuals and makes the residual output easier to
+  interpret geometrically, without affecting the results.
+* Excluded force plates from the parameter identification study, as they were
+  unnecessary. This change may slightly speed up the parameter identification
+  process.
 
 (ammr-3.0.4-changelog)=
 ## AMMR 3.0.4 (2024-07-02)

diff --git a/Docs/conf.py b/Docs/conf.py
@@ -113,7 +113,7 @@ def tagged_commit():
 highlight_language = "AnyScriptDoc"
 pygments_style = "AnyScript"
 
-ams_version = os.environ.get("AMS_VERSION", "8.0.4")
+ams_version = os.environ.get("AMS_VERSION", "8.1.0")
 if not re.match(r"^\d\.\d\.\d", ams_version):
     raise ValueError("Wrong format for AMS version, environment variable")
 ams_version_short = ams_version.rpartition(".")[0]
@@ -373,7 +373,6 @@ def tagged_commit():
     "https://dx.doi.org/10.1002/jor.20255",  # wiley.com prevents the linkcheck
     "https://doi.org/10.1016/j.clinbiomech.2006.10.003",  # clinbiomech.com prevents the linkcheck
     "https://doi.org/10.1002/jor.25267",  # wiley.com prevents the linkcheck
-    "https://doi.org/10.5281/zenodo.12592455",  # AMMR 3.0.4 not released yet
     "https://web.archive.org*",  # web.archive.org is currently down due to hacking atacks
 ]
 

diff --git a/Docs/creating_model_from_scratch.md b/Docs/creating_model_from_scratch.md
@@ -34,7 +34,7 @@ Otherwise, make the necessary changes.
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 1
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
 
@@ -52,7 +52,7 @@ Kinematics and Inverse Dynamics simulations on your model.
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 4-8,11-16
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
 
@@ -88,7 +88,7 @@ two `AnyBodyStudy` objects - one with references to (human & chair) and the othe
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 13
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
 
@@ -119,7 +119,7 @@ the human body model alone. The file path `<ANYBODY_PATH_BODY>` is defined in `l
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 4
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
     #include "<ANYBODY_PATH_BODY>/HumanModel.any"
@@ -150,7 +150,7 @@ Create a reference to the human body model inside `Model` so that it is consider
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 8
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
     #include "<ANYBODY_PATH_BODY>/HumanModel.any"
@@ -197,7 +197,7 @@ constraints enforced by soft drivers. The alternative would have been to create
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 9,20-21
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
     #include "<ANYBODY_PATH_BODY>/HumanModel.any"
@@ -236,7 +236,7 @@ of the Pelvis w.r.t ground.
 ```{code-block} AnyScriptDoc
 :emphasize-lines: 11-19
 
-#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.0.x/AMMR.v3.0.0-Demo/libdef.any"
+#include "<ANYBODY_PATH_MYFILES>/AnyBody.8.1.x/AMMR.v3.1.0-Demo/libdef.any"
 Main =
 {
     #include "<ANYBODY_PATH_BODY>/HumanModel.any"