Merge pull request #71 from Ipuch/opensim_rm

Ipuch · web-flow · commit 1ea87f6a0fad · 2025-07-16T17:10:06.000+02:00
Improves OpenSim dependency handling
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ And also animate biorbd models from the pyomeca organization.
 
 ``` conda install -c conda-forge pyorerun rerun-sdk=0.21```
 
-``` conda install opensim-org::opensim   # mandatory dependency```
+``` conda install opensim-org::opensim   # not a mandatory dependency```
 
 # Rerun .c3d - As simple as that
 
@@ -59,7 +59,9 @@ animation.rerun()
 
 ## From source
 ```conda install -c conda-forge ezc3d rerun-sdk=0.21 trimesh numpy biorbd pyomeca tk imageio imageio-ffmpeg```
-```conda install opensim-org::opensim```
+
+if you want to use the OpenSim, you also need to install separately:
+```conda install -c opensim-org::opensim```
 
 Then, ensure it is accessible in your Python environment by installing the package:
 
diff --git a/pyorerun/__init__.py b/pyorerun/__init__.py
@@ -2,11 +2,19 @@
 from .live_integration import LiveModelIntegration
 from .model_components.model_display_options import DisplayModelOptions
 from .model_components.model_updapter import ModelUpdater
+
+try:
+    from .model_interfaces import (
+        OsimModel,
+        OsimModelNoMesh,
+    )
+except ImportError:
+    # OpenSim n'est pas installé, ces classes ne seront pas disponibles
+    pass
+
 from .model_interfaces import (
     BiorbdModel,
     BiorbdModelNoMesh,
-    OsimModel,
-    OsimModelNoMesh,
     AbstractSegment,
     AbstractModel,
     AbstractModelNoMesh,
diff --git a/pyorerun/live_animation.py b/pyorerun/live_animation.py
@@ -4,8 +4,6 @@
 import numpy as np
 import rerun as rr
 
-from .model_interfaces.biorbd_model_interface import BiorbdModel
-from .model_interfaces.osim_model_interface import OsimModel
 from .model_components.model_updapter import ModelUpdater
 from .model_components.model_display_options import DisplayModelOptions
 
diff --git a/pyorerun/model_components/model_updapter.py b/pyorerun/model_components/model_updapter.py
@@ -12,14 +12,14 @@
 from ..abstract.linestrip import LineStripProperties
 from ..abstract.markers import MarkerProperties
 from ..model_components.ligaments import LigamentsUpdater, MusclesUpdater, LineStripUpdaterFromGlobalTransform
-from ..model_interfaces import BiorbdModel, BiorbdModelNoMesh, OsimModel, OsimModelNoMesh, AbstractModel
+from ..model_interfaces import AbstractModel, model_from_file
 
 
 class ModelUpdater(Components):
     def __init__(
         self,
-        name: str,
-        model: BiorbdModelNoMesh | BiorbdModel | OsimModelNoMesh | OsimModel | AbstractModel,
+        name,
+        model: AbstractModel,
         muscle_colors: np.ndarray = None,
     ):
         self.name = name
@@ -62,14 +62,7 @@ def from_file(cls, model_path: str, options: DisplayModelOptions = None):
         >>> rr.log("anything", rr.Anything())
 
         """
-        if model_path.endswith(".osim"):
-            model = OsimModel(model_path, options=options)
-            no_mesh_instance = OsimModelNoMesh
-        elif model_path.endswith(".bioMod"):
-            model = BiorbdModel(model_path, options=options)
-            no_mesh_instance = BiorbdModelNoMesh
-        else:
-            raise ValueError("The model must be in biorbd or opensim format.")
+        model, no_mesh_instance = model_from_file(model_path, options=options)
 
         if model.has_mesh or model.has_meshlines:
             return cls(model.name, model)
diff --git a/pyorerun/model_interfaces/__init__.py b/pyorerun/model_interfaces/__init__.py
@@ -1,3 +1,10 @@
 from .abstract_model_interface import AbstractSegment, AbstractModel, AbstractModelNoMesh
 from .biorbd_model_interface import BiorbdModelNoMesh, BiorbdModel
-from .osim_model_interface import OsimModelNoMesh, OsimModel
+
+try:
+    from .osim_model_interface import OsimModelNoMesh, OsimModel
+except ImportError:
+    # OpenSim n'est pas installé, ces classes ne seront pas disponibles
+    pass
+
+from .available_interfaces import model_from_file
diff --git a/pyorerun/model_interfaces/available_interfaces.py b/pyorerun/model_interfaces/available_interfaces.py
@@ -0,0 +1,49 @@
+from .abstract_model_interface import AbstractModel, AbstractModelNoMesh
+from .biorbd_model_interface import BiorbdModelNoMesh, BiorbdModel
+from ..model_components.model_display_options import DisplayModelOptions
+
+AVAILABLE_INTERFACES = {
+    "biorbd": (BiorbdModel, BiorbdModelNoMesh),
+}
+
+try:
+    from .osim_model_interface import OsimModelNoMesh, OsimModel
+
+    AVAILABLE_INTERFACES["opensim"] = (OsimModel, OsimModelNoMesh)
+except ImportError:
+    # OpenSim n'est pas installé, ces classes ne seront pas disponibles
+    pass
+
+
+def model_from_file(model_path: str, options: DisplayModelOptions = None) -> tuple[AbstractModel, AbstractModelNoMesh]:
+    """
+    Create a model interface based on the provided model path.
+
+    Parameters
+    ----------
+    model_path : str
+        Path to the model file (either .osim or .bioMod).
+    options : dict, optional
+        Options for the model interface.
+
+    Returns
+    -------
+    tuple[AbstractModel, AbstractModelNoMesh]
+        A tuple containing the model interface and a no-mesh instance of the model.
+    """
+
+    if model_path.endswith(".osim"):
+        if "opensim" not in AVAILABLE_INTERFACES:
+            raise ImportError(
+                f"OpenSim is not installed. Please install it to use OpenSim models."
+                f"Use: conda install opensim-org::opensim"
+            )
+        model = AVAILABLE_INTERFACES["opensim"][0](model_path, options=options)
+        no_instance_mesh = AVAILABLE_INTERFACES["opensim"][1]
+    elif model_path.endswith(".bioMod"):
+        model = AVAILABLE_INTERFACES["biorbd"][0](model_path, options=options)
+        no_instance_mesh = AVAILABLE_INTERFACES["biorbd"][1]
+    else:
+        raise ValueError("The model must be in biorbd or opensim format.")
+
+    return model, no_instance_mesh
diff --git a/tests/test_osim_series.py b/tests/test_osim_series.py
@@ -0,0 +1,63 @@
+from pathlib import Path
+
+import numpy as np
+import pytest
+
+from pyorerun import OsimTimeSeries
+
+try:
+    import opensim
+
+    HAS_OPENSIM = True
+except ImportError:
+    HAS_OPENSIM = False
+
+
+@pytest.mark.skipif(not HAS_OPENSIM, reason="OpenSim is not installed.")
+def test_osim_time_series():
+
+    MOT_FILE = "../examples/osim/ik.mot"
+    OSIM_TIME_SERIES = OsimTimeSeries(str(Path(__file__).parent) + "/" + MOT_FILE)
+
+    assert isinstance(OSIM_TIME_SERIES, OsimTimeSeries)
+    assert OSIM_TIME_SERIES.coordinate_names == (
+        "pelvis_tilt",
+        "pelvis_list",
+        "pelvis_rotation",
+        "pelvis_tx",
+        "pelvis_ty",
+        "pelvis_tz",
+        "hip_flexion_r",
+        "hip_adduction_r",
+        "hip_rotation_r",
+        "knee_angle_r",
+        "ankle_angle_r",
+        "subtalar_angle_r",
+        "mtp_angle_r",
+        "hip_flexion_l",
+        "hip_adduction_l",
+        "hip_rotation_l",
+        "knee_angle_l",
+        "ankle_angle_l",
+        "subtalar_angle_l",
+        "mtp_angle_l",
+        "lumbar_extension",
+        "lumbar_bending",
+        "lumbar_rotation",
+        "arm_flex_r",
+        "arm_add_r",
+        "arm_rot_r",
+        "elbow_flex_r",
+        "pro_sup_r",
+        "wrist_flex_r",
+        "wrist_dev_r",
+        "arm_flex_l",
+        "arm_add_l",
+        "arm_rot_l",
+        "elbow_flex_l",
+        "pro_sup_l",
+        "wrist_flex_l",
+        "wrist_dev_l",
+    )
+    assert OSIM_TIME_SERIES.q[0, 50] == np.float64(3.16086172)
+    assert OSIM_TIME_SERIES.is_degree is True
diff --git a/tests/test_xp_phase.py b/tests/test_xp_phase.py
@@ -1,13 +1,7 @@
-from pathlib import Path
-
-import numpy as np
-
-from pyorerun import OsimTimeSeries
 from pyorerun.abstract.abstract_class import ExperimentalData
 from pyorerun.xp_phase import XpRerunPhase
 
 MOT_FILE = "../examples/osim/ik.mot"
-OSIM_TIME_SERIES = OsimTimeSeries(str(Path(__file__).parent) + "/" + MOT_FILE)
 
 
 class MockExperimentalData(ExperimentalData):
@@ -91,48 +85,3 @@ def test_component_names():
     phase.add_data(data2)
 
     assert phase.component_names == ["data1", "data2"]
-
-
-def test_osim_time_series():
-    assert isinstance(OSIM_TIME_SERIES, OsimTimeSeries)
-    assert OSIM_TIME_SERIES.coordinate_names == (
-        "pelvis_tilt",
-        "pelvis_list",
-        "pelvis_rotation",
-        "pelvis_tx",
-        "pelvis_ty",
-        "pelvis_tz",
-        "hip_flexion_r",
-        "hip_adduction_r",
-        "hip_rotation_r",
-        "knee_angle_r",
-        "ankle_angle_r",
-        "subtalar_angle_r",
-        "mtp_angle_r",
-        "hip_flexion_l",
-        "hip_adduction_l",
-        "hip_rotation_l",
-        "knee_angle_l",
-        "ankle_angle_l",
-        "subtalar_angle_l",
-        "mtp_angle_l",
-        "lumbar_extension",
-        "lumbar_bending",
-        "lumbar_rotation",
-        "arm_flex_r",
-        "arm_add_r",
-        "arm_rot_r",
-        "elbow_flex_r",
-        "pro_sup_r",
-        "wrist_flex_r",
-        "wrist_dev_r",
-        "arm_flex_l",
-        "arm_add_l",
-        "arm_rot_l",
-        "elbow_flex_l",
-        "pro_sup_l",
-        "wrist_flex_l",
-        "wrist_dev_l",
-    )
-    assert OSIM_TIME_SERIES.q[0, 50] == np.float64(3.16086172)
-    assert OSIM_TIME_SERIES.is_degree is True
