myo-sim 0.2.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. myo_sim/__init__.py +189 -0
  2. myo_sim/build/README.md +25 -0
  3. myo_sim/build/__init__.py +1 -0
  4. myo_sim/build/compose.py +727 -0
  5. myo_sim/build/hand.py +194 -0
  6. myo_sim/build/utils.py +428 -0
  7. myo_sim/fragments.py +44 -0
  8. myo_sim/models/arm/README.md +52 -0
  9. myo_sim/models/arm/README_hand.md +48 -0
  10. myo_sim/models/arm/assets/myoarm_r_assets.xml +127 -0
  11. myo_sim/models/arm/assets/myoarm_r_chain.xml +926 -0
  12. myo_sim/models/arm/assets/myoarm_r_muscle.xml +69 -0
  13. myo_sim/models/arm/assets/myoarm_r_tendon.xml +617 -0
  14. myo_sim/models/contacts/myoarm_contacts.xml +44 -0
  15. myo_sim/models/contacts/myofullbody_contacts.xml +26 -0
  16. myo_sim/models/contacts/myohand_contacts.xml +24 -0
  17. myo_sim/models/contacts/myolegs26_contacts.xml +30 -0
  18. myo_sim/models/contacts/myolegs_contacts.xml +36 -0
  19. myo_sim/models/head/README.md +30 -0
  20. myo_sim/models/head/assets/myohead_rigid_chain.xml +31 -0
  21. myo_sim/models/head/assets/myohead_simple_assets.xml +35 -0
  22. myo_sim/models/leg/README.md +81 -0
  23. myo_sim/models/leg/assets/myolegs26_assets.xml +78 -0
  24. myo_sim/models/leg/assets/myolegs26_chain.xml +240 -0
  25. myo_sim/models/leg/assets/myolegs26_muscle.xml +45 -0
  26. myo_sim/models/leg/assets/myolegs26_tendon.xml +167 -0
  27. myo_sim/models/leg/assets/myolegs_assets.xml +83 -0
  28. myo_sim/models/leg/assets/myolegs_chain.xml +536 -0
  29. myo_sim/models/leg/assets/myolegs_muscle.xml +91 -0
  30. myo_sim/models/leg/assets/myolegs_tendon.xml +501 -0
  31. myo_sim/models/legacy/README.md +52 -0
  32. myo_sim/models/legacy/elbow/README.md +34 -0
  33. myo_sim/models/legacy/elbow/assets/myoelbow_1dof6muscles_1dofexo_body.xml +185 -0
  34. myo_sim/models/legacy/elbow/assets/myoelbow_1dof6muscles_body.xml +174 -0
  35. myo_sim/models/legacy/elbow/assets/myoelbow_2dof6muscles_body.xml +175 -0
  36. myo_sim/models/legacy/elbow/assets/myoelbow_assets.xml +116 -0
  37. myo_sim/models/legacy/elbow/myoelbow_1dof6muscles.xml +16 -0
  38. myo_sim/models/legacy/elbow/myoelbow_1dof6muscles_1dofSoftexo_Ideal.xml +243 -0
  39. myo_sim/models/legacy/elbow/myoelbow_1dof6muscles_1dofSoftexo_sim2.xml +248 -0
  40. myo_sim/models/legacy/elbow/myoelbow_1dof6muscles_1dofexo.xml +16 -0
  41. myo_sim/models/legacy/elbow/myoelbow_2dof6muscles.xml +16 -0
  42. myo_sim/models/legacy/finger/README.md +21 -0
  43. myo_sim/models/legacy/finger/finger_v0.xml +128 -0
  44. myo_sim/models/legacy/finger/motorfinger_v0.xml +17 -0
  45. myo_sim/models/legacy/finger/myofinger_v0.xml +17 -0
  46. myo_sim/models/legacy/osl/README.md +127 -0
  47. myo_sim/models/legacy/osl/assets/myolegs_osl_assets.xml +511 -0
  48. myo_sim/models/legacy/osl/assets/myolegs_osl_chain.xml +438 -0
  49. myo_sim/models/legacy/osl/myolegs_osl.xml +40 -0
  50. myo_sim/models/legacy/torso/assets/myotorso_rigid_assets.xml +27 -0
  51. myo_sim/models/legacy/torso/assets/myotorso_rigid_chain.xml +25 -0
  52. myo_sim/models/meshes/1mc.stl +0 -0
  53. myo_sim/models/meshes/2distph.stl +0 -0
  54. myo_sim/models/meshes/2mc.stl +0 -0
  55. myo_sim/models/meshes/2midph.stl +0 -0
  56. myo_sim/models/meshes/2proxph.stl +0 -0
  57. myo_sim/models/meshes/3distph.stl +0 -0
  58. myo_sim/models/meshes/3mc.stl +0 -0
  59. myo_sim/models/meshes/3midph.stl +0 -0
  60. myo_sim/models/meshes/3proxph.stl +0 -0
  61. myo_sim/models/meshes/4distph.stl +0 -0
  62. myo_sim/models/meshes/4mc.stl +0 -0
  63. myo_sim/models/meshes/4midph.stl +0 -0
  64. myo_sim/models/meshes/4proxph.stl +0 -0
  65. myo_sim/models/meshes/5distph.stl +0 -0
  66. myo_sim/models/meshes/5mc.stl +0 -0
  67. myo_sim/models/meshes/5midph.stl +0 -0
  68. myo_sim/models/meshes/5proxph.stl +0 -0
  69. myo_sim/models/meshes/capitate.stl +0 -0
  70. myo_sim/models/meshes/clavicle.stl +0 -0
  71. myo_sim/models/meshes/ground_jaw.stl +0 -0
  72. myo_sim/models/meshes/ground_skull.stl +0 -0
  73. myo_sim/models/meshes/ground_spine.stl +0 -0
  74. myo_sim/models/meshes/hamate.stl +0 -0
  75. myo_sim/models/meshes/hat_cervical.stl +0 -0
  76. myo_sim/models/meshes/hat_jaw.stl +0 -0
  77. myo_sim/models/meshes/hat_lumbar.stl +0 -0
  78. myo_sim/models/meshes/hat_ribs_scap.stl +0 -0
  79. myo_sim/models/meshes/hat_skull.stl +0 -0
  80. myo_sim/models/meshes/hat_thoracic.stl +0 -0
  81. myo_sim/models/meshes/humerus.stl +0 -0
  82. myo_sim/models/meshes/l_bofoot.stl +0 -0
  83. myo_sim/models/meshes/l_femur.stl +0 -0
  84. myo_sim/models/meshes/l_fibula.stl +0 -0
  85. myo_sim/models/meshes/l_foot.stl +0 -0
  86. myo_sim/models/meshes/l_patella.stl +0 -0
  87. myo_sim/models/meshes/l_pelvis.stl +0 -0
  88. myo_sim/models/meshes/l_talus.stl +0 -0
  89. myo_sim/models/meshes/l_tibia.stl +0 -0
  90. myo_sim/models/meshes/lower_exo_belt.stl +0 -0
  91. myo_sim/models/meshes/lower_exo_legs.stl +0 -0
  92. myo_sim/models/meshes/lumbar1.stl +0 -0
  93. myo_sim/models/meshes/lumbar2.stl +0 -0
  94. myo_sim/models/meshes/lumbar3.stl +0 -0
  95. myo_sim/models/meshes/lumbar4.stl +0 -0
  96. myo_sim/models/meshes/lumbar5.stl +0 -0
  97. myo_sim/models/meshes/lunate.stl +0 -0
  98. myo_sim/models/meshes/osl_ankle_v2.stl +0 -0
  99. myo_sim/models/meshes/osl_custom_foot_v2.stl +0 -0
  100. myo_sim/models/meshes/osl_femur_trans_r.stl +0 -0
  101. myo_sim/models/meshes/osl_generic_socket.stl +0 -0
  102. myo_sim/models/meshes/osl_knee_v2.stl +0 -0
  103. myo_sim/models/meshes/osl_proximal_adapter_v2.stl +0 -0
  104. myo_sim/models/meshes/pisiform.stl +0 -0
  105. myo_sim/models/meshes/r_bofoot.stl +0 -0
  106. myo_sim/models/meshes/r_femur.stl +0 -0
  107. myo_sim/models/meshes/r_fibula.stl +0 -0
  108. myo_sim/models/meshes/r_foot.stl +0 -0
  109. myo_sim/models/meshes/r_patella.stl +0 -0
  110. myo_sim/models/meshes/r_pelvis.stl +0 -0
  111. myo_sim/models/meshes/r_talus.stl +0 -0
  112. myo_sim/models/meshes/r_tibia.stl +0 -0
  113. myo_sim/models/meshes/radius.stl +0 -0
  114. myo_sim/models/meshes/sacrum.stl +0 -0
  115. myo_sim/models/meshes/scaphoid.stl +0 -0
  116. myo_sim/models/meshes/scapula.stl +0 -0
  117. myo_sim/models/meshes/thoracic10_s.stl +0 -0
  118. myo_sim/models/meshes/thoracic11_s.stl +0 -0
  119. myo_sim/models/meshes/thoracic12_s.stl +0 -0
  120. myo_sim/models/meshes/thoracic1_s.stl +0 -0
  121. myo_sim/models/meshes/thoracic2_s.stl +0 -0
  122. myo_sim/models/meshes/thoracic3_s.stl +0 -0
  123. myo_sim/models/meshes/thoracic4_s.stl +0 -0
  124. myo_sim/models/meshes/thoracic5_s.stl +0 -0
  125. myo_sim/models/meshes/thoracic6_s.stl +0 -0
  126. myo_sim/models/meshes/thoracic7_s.stl +0 -0
  127. myo_sim/models/meshes/thoracic8_s.stl +0 -0
  128. myo_sim/models/meshes/thoracic9_s.stl +0 -0
  129. myo_sim/models/meshes/thorax.stl +0 -0
  130. myo_sim/models/meshes/thumbdist.stl +0 -0
  131. myo_sim/models/meshes/thumbprox.stl +0 -0
  132. myo_sim/models/meshes/torso_lowpoly-v1.stl +0 -0
  133. myo_sim/models/meshes/trapezium.stl +0 -0
  134. myo_sim/models/meshes/trapezoid.stl +0 -0
  135. myo_sim/models/meshes/triquetrum.stl +0 -0
  136. myo_sim/models/meshes/ulna.stl +0 -0
  137. myo_sim/models/meshes/upper_exo.stl +0 -0
  138. myo_sim/models/scene/floor0.png +0 -0
  139. myo_sim/models/scene/myobody_skeleton_decor.xml +86 -0
  140. myo_sim/models/scene/myobody_skeleton_decor_assets.xml +42 -0
  141. myo_sim/models/scene/myosuite_icon.png +0 -0
  142. myo_sim/models/scene/myosuite_logo.msh +0 -0
  143. myo_sim/models/scene/myosuite_logo.mtl +45 -0
  144. myo_sim/models/scene/myosuite_logo.obj +58016 -0
  145. myo_sim/models/scene/myosuite_logo.png +0 -0
  146. myo_sim/models/scene/myosuite_quad.xml +58 -0
  147. myo_sim/models/scene/myosuite_scene.msh +0 -0
  148. myo_sim/models/scene/myosuite_scene.mtl +8 -0
  149. myo_sim/models/scene/myosuite_scene.obj +29991 -0
  150. myo_sim/models/scene/myosuite_scene.png +0 -0
  151. myo_sim/models/scene/myosuite_scene.xml +56 -0
  152. myo_sim/models/scene/myosuite_scene_musclemimic.xml +19 -0
  153. myo_sim/models/scene/myosuite_scene_noFloor.msh +0 -0
  154. myo_sim/models/scene/myosuite_scene_noFloor.mtl +8 -0
  155. myo_sim/models/scene/myosuite_scene_noFloor.obj +29981 -0
  156. myo_sim/models/scene/myosuite_scene_noFloor.png +0 -0
  157. myo_sim/models/scene/myosuite_scene_noFloor_noPedestal.msh +0 -0
  158. myo_sim/models/scene/myosuite_scene_noFloor_noPedestal.obj +26704 -0
  159. myo_sim/models/scene/myosuite_scene_noPedestal.xml +57 -0
  160. myo_sim/models/scene/myosuite_warning.png +0 -0
  161. myo_sim/models/sensors/myofullbody_sensors.xml +110 -0
  162. myo_sim/models/sensors/myolegs26_sensors.xml +16 -0
  163. myo_sim/models/sensors/myolegs_sensors.xml +8 -0
  164. myo_sim/models/textures/ground_brown.png +0 -0
  165. myo_sim/models/textures/ground_grey.png +0 -0
  166. myo_sim/models/torso/README.md +56 -0
  167. myo_sim/models/torso/assets/myotorso_abdomen_muscle.xml +10 -0
  168. myo_sim/models/torso/assets/myotorso_abdomen_tendon.xml +31 -0
  169. myo_sim/models/torso/assets/myotorso_assets.xml +116 -0
  170. myo_sim/models/torso/assets/myotorso_chain.xml +780 -0
  171. myo_sim/models/torso/assets/myotorso_muscle.xml +214 -0
  172. myo_sim/models/torso/assets/myotorso_tendon.xml +1044 -0
  173. myo_sim-0.2.0.dist-info/METADATA +9 -0
  174. myo_sim-0.2.0.dist-info/RECORD +177 -0
  175. myo_sim-0.2.0.dist-info/WHEEL +5 -0
  176. myo_sim-0.2.0.dist-info/licenses/LICENSE +201 -0
  177. myo_sim-0.2.0.dist-info/top_level.txt +1 -0
myo_sim/__init__.py ADDED
@@ -0,0 +1,189 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+ from pathlib import Path
3
+ from typing import TYPE_CHECKING
4
+
5
+ from myo_sim.fragments import FragmentInfo as FragmentInfo
6
+ from myo_sim.fragments import FragmentRegistry as FragmentRegistry
7
+
8
+ if TYPE_CHECKING:
9
+ import mujoco
10
+
11
+ try:
12
+ __version__ = version("myo-sim")
13
+ except PackageNotFoundError:
14
+ __version__ = "0.0.0+unknown"
15
+
16
+ # Root of the packaged XML model tree.
17
+ MODELS_DIR = Path(__file__).resolve().parent / "models"
18
+
19
+ # Catalog of static XML fragments: (name, rel_path, version).
20
+ # Only list models whose XML files are actually present in myo_sim/models/.
21
+ # Legacy names match myosuite's _FALLBACK_PATHS so ModelBuilder resolves them
22
+ # via FragmentRegistry before falling back to the simhive submodule.
23
+ _FRAGMENT_CATALOG: list[tuple[str, str, int]] = [
24
+ # Legacy models — pending proper migration (see legacy/README.md).
25
+ ("elbow", "legacy/elbow/myoelbow_1dof6muscles.xml", 1),
26
+ ("myoelbow", "legacy/elbow/myoelbow_1dof6muscles.xml", 1),
27
+ ("myoelbow_2dof", "legacy/elbow/myoelbow_2dof6muscles.xml", 1),
28
+ ("myoelbow_exo", "legacy/elbow/myoelbow_1dof6muscles_1dofexo.xml", 1),
29
+ ("finger", "legacy/finger/myofinger_v0.xml", 1),
30
+ ("myofinger", "legacy/finger/myofinger_v0.xml", 1),
31
+ ("osl", "legacy/osl/myolegs_osl.xml", 1),
32
+ ("myolegs_osl", "legacy/osl/myolegs_osl.xml", 1),
33
+ ]
34
+
35
+ REGISTRY: dict[str, str] = {}
36
+
37
+ for _name, _rel, _ver in _FRAGMENT_CATALOG:
38
+ _p = MODELS_DIR / _rel
39
+ if _p.exists():
40
+ FragmentRegistry._store[_name] = FragmentInfo(name=_name, path=_p, version=_ver)
41
+ REGISTRY[_name] = _rel
42
+
43
+
44
+ def get_xml_path(name: str) -> Path:
45
+ """Return the absolute Path to a named model XML.
46
+
47
+ Raises ValueError for unknown names.
48
+ """
49
+ if name not in REGISTRY:
50
+ raise ValueError(f"Unknown model {name!r}. Available: {sorted(REGISTRY)}")
51
+ return MODELS_DIR / REGISTRY[name]
52
+
53
+
54
+ def _composed_models() -> frozenset[str]:
55
+ """Names loadable via the MjSpec compose pipeline (registry keys + aliases).
56
+
57
+ Derived from ``MODEL_REGISTRY`` and ``ALIASES`` so there is a single source
58
+ of truth; importing compose here (rather than at module top) keeps
59
+ ``import myo_sim`` free of a MuJoCo dependency.
60
+ """
61
+ from myo_sim.build.compose import ALIASES, MODEL_REGISTRY
62
+
63
+ return frozenset(MODEL_REGISTRY) | frozenset(ALIASES)
64
+
65
+
66
+ def __getattr__(name: str):
67
+ # Preserve the historical ``myo_sim._COMPOSED_MODELS`` attribute while keeping
68
+ # its contents derived from the compose registry instead of a hand-kept copy.
69
+ if name == "_COMPOSED_MODELS":
70
+ return _composed_models()
71
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
72
+
73
+
74
+ def _right_hand_spec():
75
+ from myo_sim.build.compose import load_right_hand_from_arm_spec
76
+
77
+ return load_right_hand_from_arm_spec()
78
+
79
+
80
+ def _left_hand_spec():
81
+ from myo_sim.build.compose import load_left_hand_from_arm_spec
82
+
83
+ return load_left_hand_from_arm_spec()
84
+
85
+
86
+ def _legs_spec():
87
+ from myo_sim.build.compose import load_legs_spec
88
+
89
+ return load_legs_spec()
90
+
91
+
92
+ def _legs26_spec():
93
+ from myo_sim.build.compose import load_legs26_spec
94
+
95
+ return load_legs26_spec()
96
+
97
+
98
+ # TODO: there should be a myohand_l alias, which should work with load. Also a given name (myolegs) should refer to the
99
+ # same model consistently.
100
+ # Maps fragment names to zero-arg callables returning an editable (uncompiled)
101
+ # MjSpec, with no torso scaffold. Used by downstream consumers (e.g. myosuite
102
+ # ModelBuilder, assist_sim) so that attaching a fragment routes through the compose
103
+ # pipeline instead of falling back to a bundled static XML. Includes myohand_l
104
+ # (left hand only); there is no myo_sim.load("myohand_l") alias — use this dict or
105
+ # myohands instead. Note "myolegs" here is the bare legs fragment; myo_sim.load(
106
+ # "myolegs") differs in that it attaches the legs to a passive torso scaffold.
107
+ FRAGMENT_SPEC_BUILDERS: dict[str, object] = {
108
+ "hand": _right_hand_spec,
109
+ "myohand": _right_hand_spec,
110
+ "myohand_r": _right_hand_spec,
111
+ "myohand_l": _left_hand_spec,
112
+ "myolegs": _legs_spec,
113
+ "myolegs26": _legs26_spec,
114
+ }
115
+
116
+
117
+ def load(name: str) -> tuple:
118
+ """Load a MuJoCo model by registry name. Returns (MjModel, MjData).
119
+
120
+ Supports MjSpec-composed models such as myohand_r, myohands, myoarms,
121
+ myofullbody, and myolegs, plus packaged legacy static XMLs. For a
122
+ left-hand-only MjSpec builder, use FRAGMENT_SPEC_BUILDERS["myohand_l"].
123
+ """
124
+ import mujoco
125
+
126
+ model = load_model(name)
127
+ return model, mujoco.MjData(model)
128
+
129
+
130
+ def load_model(name: str) -> tuple:
131
+ spec = load_spec(name)
132
+ model = spec.compile()
133
+ return model
134
+
135
+
136
+ def load_spec(name: str) -> "mujoco.MjSpec":
137
+ """Build and return the uncompiled MjSpec for a named model.
138
+
139
+ Unlike load(), this stops at the editable MjSpec so downstream consumers
140
+ (e.g. assist_sim) can edit the model -- attach devices, delete bodies, add
141
+ actuators -- before compiling it themselves.
142
+ """
143
+ import mujoco
144
+
145
+ from myo_sim.build.compose import ALIASES, build_spec
146
+
147
+ composed_models = _composed_models()
148
+ if name in composed_models:
149
+ # Legacy aliases (e.g. hand, myohand, myoarm) resolve to a registry entry.
150
+ composed_name = ALIASES.get(name, name)
151
+ spec = build_spec(composed_name)
152
+ return spec
153
+
154
+ if name not in REGISTRY:
155
+ available = sorted(composed_models | frozenset(REGISTRY))
156
+ raise ValueError(f"Unknown model {name!r}. Available: {available}")
157
+
158
+ spec = mujoco.MjSpec.from_file(str(get_xml_path(name)))
159
+ return spec
160
+
161
+
162
+ def get_path(rel: str) -> Path:
163
+ """Return the absolute Path to a model file by relative path within MODELS_DIR.
164
+
165
+ This is a convenience wrapper for scripts and tutorials that prefer to
166
+ reference models by relative path (e.g. ``"scene/myosuite_scene.xml"``)
167
+ rather than registry name.
168
+
169
+ Args:
170
+ rel: Relative path inside MODELS_DIR, e.g. ``"scene/myosuite_scene.xml"``.
171
+
172
+ Returns:
173
+ Absolute Path to the file.
174
+
175
+ Raises:
176
+ FileNotFoundError: If the path does not exist.
177
+ """
178
+ p = MODELS_DIR / rel
179
+ if not p.exists():
180
+ raise FileNotFoundError(f"Model file not found: {p}")
181
+ return p
182
+
183
+
184
+ def print_path(name: str | None = None) -> None:
185
+ """Print packaged model file paths."""
186
+ if name:
187
+ print(get_path(name))
188
+ else:
189
+ print(MODELS_DIR)
@@ -0,0 +1,25 @@
1
+ # MjSpec Prototypes
2
+
3
+ This folder contains prototype utilities for composing MuJoCo models with
4
+ `mujoco.MjSpec` instead of relying only on static MJCF includes.
5
+
6
+ The main entry point is:
7
+
8
+ ```bash
9
+ uv run python -m myo_sim.build.compose --model myotorso_arms --view
10
+ ```
11
+
12
+ Available registered models:
13
+
14
+ - `myotorso_arms`: full torso plus right arm and a mirrored-left arm.
15
+ - `myoarm_r`: passive anatomical torso scaffold plus right arm only.
16
+ - `myotorso_arm_r`: full torso plus right arm only.
17
+ - `myofullbody`: torso, mirrored arms, and legs.
18
+ - `myolegs26`: passive anatomical torso scaffold with reduced 26-muscle legs.
19
+ - `myolegs_abdomen`: simple abdomen scaffold plus legs.
20
+ - `myoarms`: passive anatomical torso scaffold plus mirrored arms.
21
+ - `myohand_r`: passive anatomical torso scaffold plus a right hand derived by pruning `myoarm_r`.
22
+ - `myohands`: passive anatomical torso scaffold plus right and mirrored-left hands derived from arm specs.
23
+
24
+ `utils.py` contains shared XML and mirroring helpers. `hand.py` contains the
25
+ hand-specific pruning logic used to derive hand-only specs from arm specs.
@@ -0,0 +1 @@
1
+ """MjSpec composition prototypes for MyoSim models."""