Skip to content

Commit 7431ba6

Browse files
authored
Merge pull request #4091 from nickbianco/moco_examples_doxygen_fix
Add missing Moco examples to Doxygen examples list
2 parents 74a7fda + bd6b590 commit 7431ba6

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

doc/Moco/MocoExamples.dox

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ This is Moco's simplest example.
6161
This example conducts a 2-D prediction of walking, employing a
6262
MocoPerodicityGoal.
6363

64+
@example example2DWalkingMetabolics.m
65+
This is an example using the MocoTrack tool that also shows how to
66+
minimize the total metabolic rate employing the
67+
Bhargava2004SmoothedMuscleMetabolics.
68+
69+
@example example3DWalking.m
70+
This example demonstrates how to track kinematics and ground reaction
71+
forces to generate a 3-D walking simulation.
72+
6473
@example examplePolynomialPathFitter.m
6574
This example demonstrates how to use PolynomialPathFitter to
6675
create a set of FunctionBasedPaths for a model.
@@ -125,6 +134,19 @@ MocoSolution.
125134
This example demonstrates how Moco solves problems with kinematic constraints
126135
and includes a visualization of the Lagrange multipliers that Moco solves for.
127136

137+
@example example2DWalking.py
138+
This example conducts a 2-D prediction of walking, employing a
139+
MocoPerodicityGoal.
140+
141+
@example example2DWalkingMetabolics.py
142+
This is an example using the MocoTrack tool that also shows how to
143+
minimize the total metabolic rate employing the
144+
Bhargava2004SmoothedMuscleMetabolics.
145+
146+
@example example3DWalking.py
147+
This example demonstrates how to track kinematics and ground reaction
148+
forces to generate a 3-D walking simulation.
149+
128150
@example examplePolynomialPathFitter.py
129151
This example demonstrates how to use PolynomialPathFitter to
130152
create a set of FunctionBasedPaths for a model.
@@ -140,6 +162,10 @@ This is an example using the MocoTrack tool that also shows how to
140162
minimize the total metabolic rate employing the
141163
Bhargava2004SmoothedMuscleMetabolics.
142164

165+
@example example3DWalking.cpp
166+
This example demonstrates how to track kinematics and ground reaction
167+
forces to generate a 3-D walking simulation.
168+
143169
@example exampleCustomImplicitAuxiliaryDynamics.cpp
144170
This example shows how to define dynamics with an implicit differential
145171
equation.
@@ -208,8 +234,8 @@ name | model/motion | description | interfaces
208234
---- | ------------ | ----------- | ----------
209235
MocoTrack | lower-limb | Using the MocoTrack tool for walking with marker tracking and state tracking; generating a PDF report | [MATLAB](@ref exampleMocoTrack.m), [Python](@ref exampleMocoTrack.py), [C++](@ref exampleMocoTrack.cpp)
210236
MocoInverse | lower-limb | Using the MocoInverse tool for walking; MocoControlTrackingGoal; generating a PDF report | [MATLAB](@ref exampleMocoInverse.m), [Python](@ref exampleMocoInverse.py), [C++](@ref exampleMocoInverse.cpp)
211-
2DWalking | walking | MocoTrack, MocoStudy prediction, MocoControlGoal, MocoAverageSpeedGoal, MocoPeriodicityGoal, MocoContactTrackingGoal, createPeriodicSolution | [MATLAB](@ref example2DWalking.m), [C++](@ref example2DWalking.cpp)
212-
2DWalkingMetabolics | walking | MocoTrack, MocoControlGoal, MocoPeriodicityGoal, Bhargava2004SmoothedMuscleMetabolics | [C++](@ref example2DWalkingMetabolics.cpp)
237+
2DWalking | walking | MocoTrack, MocoStudy prediction, MocoControlGoal, MocoAverageSpeedGoal, MocoPeriodicityGoal, MocoContactTrackingGoal, createPeriodicSolution | [MATLAB](@ref example2DWalking.m), [Python](@ref example2DWalking.py), [C++](@ref example2DWalking.cpp)
238+
2DWalkingMetabolics | walking | MocoTrack, MocoControlGoal, MocoPeriodicityGoal, Bhargava2004SmoothedMuscleMetabolics | [MATLAB](@ref example2DWalkingMetabolics.m), [Python](@ref example2DWalkingMetabolics.cpp), [C++](@ref example2DWalkingMetabolics.cpp)
213239
MarkerTracking10DOF | walking | MocoControlGoal, MocoMarkerTrackingGoal | [MATLAB](@ref exampleMarkerTracking10DOF.m)
214240
SquatToStand | torque-driven single leg | MocoStudy motion prediction, MocoInverse | [MATLAB](@ref exampleSquatToStand_answers.m) [Python](@ref exampleSquatToStand_answers.py)
215241
IMUTracking | torque-driven single leg | MocoStudy motion prediction, MocoAccelerationTrackingGoal | [MATLAB](@ref exampleIMUTracking_answers.m) [Python](@ref exampleIMUTracking_answers.py)
@@ -222,6 +248,7 @@ PolynomialPathFitter | N/A | Fit FunctionBasedPath%s to a model | [MATLAB](@ref
222248

223249
name | model/motion | description | interfaces
224250
---- | ------------ | ----------- | ----------
251+
3DWalking | walking | MocoTrack, MocoControlGoal, MocoPeriodicityGoal, MocoContactTrackingGoal | [MATLAB](@ref example3DWalking.m), [Python](@ref example3DWalking.py), [C++](@ref example3DWalking.cpp)
225252
CustomImplicitAuxiliaryDynamics | N/A | Creating a component with implicit auxiliary dynamics (like muscle tendon compliance) | [C++](@ref exampleCustomImplicitAuxiliaryDynamics.cpp)
226253
CustomEffortGoal | N/A | Creating a plugin for a custom goal | [C++](@ref exampleMocoCustomEffortGoal.cpp)
227254

0 commit comments

Comments
 (0)