jaxsim 0.2.1.dev38__tar.gz → 0.2.1.dev47__tar.gz

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jaxsim
-Version: 0.2.1.dev38
+Version: 0.2.1.dev47
 Home-page: https://github.com/ami-iit/jaxsim
 Author: Diego Ferigo
 Author-email: diego.ferigo@iit.it

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/examples/PD_controller.ipynb

@@ -6,10 +6,6 @@
    "source": [
     "# `JAXsim` Showcase: PD Controller\n",
     "\n",
-    "<a target=\"_blank\" href=\"https://colab.research.google.com/github/ami-iit/jaxsim/blob/main/examples/PD_controller.ipynb\">\n",
-    "  <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
-    "</a>\n",
-    "\n",
     "First, we install the necessary packages and import them."
    ]
   },
@@ -23,14 +19,6 @@
     "from IPython.display import clear_output, HTML, display\n",
     "import sys\n",
     "\n",
-    "IS_COLAB = \"google.colab\" in sys.modules\n",
-    "\n",
-    "# Install JAX and Gazebo\n",
-    "if IS_COLAB:\n",
-    "    !{sys.executable} -m pip install -U -q jaxsim\n",
-    "    !apt -qq update && apt install -qq --no-install-recommends gazebo\n",
-    "    clear_output()\n",
-    "\n",
     "import jax\n",
     "import jax.numpy as jnp\n",
     "from jaxsim import logging\n",
@@ -141,35 +129,6 @@
     "from jaxsim.mujoco.loaders import UrdfToMjcf\n",
     "\n",
     "\n",
-    "if IS_COLAB:\n",
-    "    if subprocess.run(\"ffmpeg -version\", shell=True).returncode:\n",
-    "        !command -v ffmpeg >/dev/null || (apt update && apt install -y ffmpeg)\n",
-    "        clear_output()\n",
-    "\n",
-    "    if subprocess.run(\"nvidia-smi\").returncode:\n",
-    "        raise RuntimeError(\n",
-    "            \"Cannot communicate with GPU. \"\n",
-    "            \"Make sure you are using a GPU Colab runtime. \"\n",
-    "            \"Go to the Runtime menu and select Choose runtime type.\"\n",
-    "        )\n",
-    "\n",
-    "    # Add an ICD config so that glvnd can pick up the Nvidia EGL driver.\n",
-    "    # This is usually installed as part of an Nvidia driver package, but the Colab\n",
-    "    # kernel doesn't install its driver via APT, and as a result the ICD is missing.\n",
-    "    # (https://github.com/NVIDIA/libglvnd/blob/master/src/EGL/icd_enumeration.md)\n",
-    "    NVIDIA_ICD_CONFIG_PATH = \"/usr/share/glvnd/egl_vendor.d/10_nvidia.json\"\n",
-    "    if not os.path.exists(NVIDIA_ICD_CONFIG_PATH):\n",
-    "        with open(NVIDIA_ICD_CONFIG_PATH, \"w\") as f:\n",
-    "            f.write(\n",
-    "                \"\"\"{\n",
-    "      \"file_format_version\" : \"1.0.0\",\n",
-    "      \"ICD\" : {\n",
-    "         \"library_path\" : \"libEGL_nvidia.so.0\"\n",
-    "     }\n",
-    "  }\n",
-    "  \"\"\"\n",
-    "            )\n",
-    "\n",
     "%env MUJOCO_GL=egl\n",
     "\n",
     "try:\n",

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/examples/Parallel_computing.ipynb

@@ -4,11 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# `JAXsim` Showcase: Parallel Simulation of a free-falling body\n",
-    "\n",
-    "<a target=\"_blank\" href=\"https://colab.research.google.com/github/ami-iit/jaxsim/blob/main/examples/Parallel_computing.ipynb\">\n",
-    "  <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
-    "</a>"
+    "# `JAXsim` Showcase: Parallel Simulation of a free-falling body"
    ]
   },
   {
@@ -29,16 +25,10 @@
     "\n",
     "from IPython.display import HTML, clear_output, display\n",
     "\n",
-    "IS_COLAB = \"google.colab\" in sys.modules\n",
-    "\n",
     "# Install JAX and Gazebo\n",
-    "if IS_COLAB:\n",
-    "    !{sys.executable} -m pip install -U -q jaxsim\n",
-    "    !apt -qq update && apt install -qq --no-install-recommends gazebo\n",
-    "    clear_output()\n",
-    "else:\n",
-    "    # Set environment variable to avoid GPU out of memory errors\n",
-    "    %env XLA_PYTHON_CLIENT_MEM_PREALLOCATE=false\n",
+    "\n",
+    "# Set environment variable to avoid GPU out of memory errors\n",
+    "%env XLA_PYTHON_CLIENT_MEM_PREALLOCATE=false\n",
     "\n",
     "import time\n",
     "from typing import Dict, Tuple\n",

jaxsim-0.2.1.dev47/examples/README.md

@@ -0,0 +1,29 @@
+# JAXsim Notebook Examples
+
+This folder includes a Jupyter Notebook demonstrating the practical usage of JAXsim for system simulations.
+
+### Examples
+
+- [PD_controller](./PD_controller.ipynb) - A simple example demonstrating the use of JAXsim to simulate a PD controller with gravity compensation for a 2-DOF cartpole.
+- [Parallel_computing](./Parallel_computing.ipynb) - An example demonstrating how to simulate vectorized models in parallel using JAXsim.
+
+> [!TIP]
+> Stay tuned for more examples!
+
+## Running the Examples
+
+To execute these examples utilizing JAXsim with hardware acceleration, you can use [pixi](https://pixi.sh) to run the examples in a local environment:
+
+1. **Install `pixi`:**
+
+As per the [official documentation](https://pixi.sh/#installation):
+
+```bash
+curl -fsSL https://pixi.sh/install.sh | bash
+```
+
+2. **Run the Example Notebook:**
+
+Use `pixi run examples` from the project source directory to execute the example notebook locally.
+
+This command will automatically handle the installation of necessary dependencies and execute the examples within a self-contained environment

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.1.dev38'
-__version_tuple__ = version_tuple = (0, 2, 1, 'dev38')
+__version__ = version = '0.2.1.dev47'
+__version_tuple__ = version_tuple = (0, 2, 1, 'dev47')

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/api/joint.py

@@ -3,7 +3,6 @@ from typing import Sequence
 
 import jax
 import jax.numpy as jnp
-import numpy as np
 
 import jaxsim.api as js
 import jaxsim.typing as jtp
@@ -30,17 +29,9 @@ def name_to_idx(model: js.model.JaxSimModel, *, joint_name: str) -> jtp.Int:
         # Note: the index of the joint for RBDAs starts from 1, but
         # the index for accessing the right element starts from 0.
         # Therefore, there is a -1.
-        return (
-            jnp.array(
-                np.argwhere(
-                    np.array(model.kin_dyn_parameters.joint_model.joint_names)
-                    == joint_name
-                )
-                - 1
-            )
-            .squeeze()
-            .astype(int)
-        )
+        return jnp.array(
+            model.kin_dyn_parameters.joint_model.joint_names.index(joint_name) - 1
+        ).squeeze()
     return jnp.array(-1).astype(int)
 
 

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/api/kin_dyn_parameters.py

@@ -382,21 +382,20 @@ class KynDynParameters(JaxsimDataclass):
         )
 
         # Compute the transforms and motion subspaces of the joints.
-        # TODO: understand how to use joint_indices to access joint_types, right now
-        #       it fails when used within a JIT context.
-        pre_H_suc_and_S = [
-            supported_joint_motion(
-                joint_type=self.joint_model.joint_types[i + 1],
-                joint_position=jnp.array(s),
+        if self.number_of_joints() == 0:
+            pre_H_suc_J, S_J = jnp.empty((0, 4, 4)), jnp.empty((0, 6, 1))
+        else:
+            pre_H_suc_J, S_J = jax.vmap(supported_joint_motion)(
+                jnp.array(self.joint_model.joint_types[1:]).astype(int),
+                jnp.array(joint_positions),
+                jnp.array(self.joint_model.joint_axis),
             )
-            for i, s in enumerate(jnp.array(joint_positions).astype(float))
-        ]
 
         # Extract the transforms and motion subspaces of the joints.
         # We stack the base transform W_H_B at index 0, and a dummy motion subspace
         # for either the fixed or free-floating joint connecting the world to the base.
-        pre_H_suc = jnp.stack([W_H_B] + [H for H, _ in pre_H_suc_and_S])
-        S = jnp.stack([jnp.vstack(jnp.zeros(6))] + [S for _, S in pre_H_suc_and_S])
+        pre_H_suc = jnp.vstack([W_H_B[jnp.newaxis, ...], pre_H_suc_J])
+        S = jnp.vstack([jnp.zeros((6, 1))[jnp.newaxis, ...], S_J])
 
         # Extract the successor-to-child fixed transforms.
         # Note that here we include also the index 0 since suc_H_child[0] stores the

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/math/joint_model.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import functools
-
 import jax
 import jax.numpy as jnp
 import jax_dataclasses
@@ -9,12 +7,7 @@ import jaxlie
 from jax_dataclasses import Static
 
 import jaxsim.typing as jtp
-from jaxsim.parsers.descriptions import (
-    JointDescriptor,
-    JointGenericAxis,
-    JointType,
-    ModelDescription,
-)
+from jaxsim.parsers.descriptions import JointGenericAxis, JointType, ModelDescription
 from jaxsim.parsers.kinematic_graph import KinematicGraphTransforms
 
 from .rotation import Rotation
@@ -46,7 +39,8 @@ class JointModel:
 
     joint_dofs: Static[tuple[int, ...]]
     joint_names: Static[tuple[str, ...]]
-    joint_types: Static[tuple[JointType | JointDescriptor, ...]]
+    joint_types: Static[tuple[JointType, ...]]
+    joint_axis: Static[tuple[JointGenericAxis, ...]]
 
     @staticmethod
     def build(description: ModelDescription) -> JointModel:
@@ -114,7 +108,8 @@ class JointModel:
             # Static attributes
             joint_dofs=tuple([base_dofs] + [int(1) for _ in ordered_joints]),
             joint_names=tuple(["world_to_base"] + [j.name for j in ordered_joints]),
-            joint_types=tuple([JointType.F] + [j.jtype for j in ordered_joints]),
+            joint_types=tuple([JointType.Fixed] + [j.jtype for j in ordered_joints]),
+            joint_axis=tuple([j.axis for j in ordered_joints]),
         )
 
     def parent_H_child(
@@ -204,8 +199,9 @@ class JointModel:
         """
 
         pre_H_suc, S = supported_joint_motion(
-            joint_type=self.joint_types[joint_index],
-            joint_position=joint_position,
+            self.joint_types[joint_index],
+            joint_position,
+            self.joint_axis[joint_index],
         )
 
         return pre_H_suc, S
@@ -226,59 +222,57 @@ class JointModel:
         return self.suc_H_i[joint_index]
 
 
-@functools.partial(jax.jit, static_argnames=["joint_type"])
+@jax.jit
 def supported_joint_motion(
-    joint_type: JointType | JointDescriptor, joint_position: jtp.VectorLike
+    joint_type: JointType,
+    joint_position: jtp.VectorLike,
+    joint_axis: JointGenericAxis,
+    /,
 ) -> tuple[jtp.Matrix, jtp.Array]:
     """
     Compute the homogeneous transformation and motion subspace of a joint.
 
     Args:
         joint_type: The type of the joint.
+        joint_axis: The axis of rotation or translation of the joint.
         joint_position: The position of the joint.
 
     Returns:
         A tuple containing the homogeneous transformation and the motion subspace.
     """
 
-    if isinstance(joint_type, JointType):
-        type_enum = joint_type
-    elif isinstance(joint_type, JointDescriptor):
-        type_enum = joint_type.joint_type
-    else:
-        raise ValueError(joint_type)
-
     # Prepare the joint position
     s = jnp.array(joint_position).astype(float)
 
-    match type_enum:
-
-        case JointType.R:
-            joint_type: JointGenericAxis
+    def compute_F():
+        return jaxlie.SE3.identity(), jnp.zeros(shape=(6, 1))
 
-            pre_H_suc = jaxlie.SE3.from_rotation(
-                rotation=jaxlie.SO3.from_matrix(
-                    Rotation.from_axis_angle(vector=s * joint_type.axis)
-                )
+    def compute_R():
+        pre_H_suc = jaxlie.SE3.from_rotation(
+            rotation=jaxlie.SO3.from_matrix(
+                Rotation.from_axis_angle(vector=s * joint_axis)
             )
+        )
 
-            S = jnp.vstack(jnp.hstack([jnp.zeros(3), joint_type.axis.squeeze()]))
-
-        case JointType.P:
-            joint_type: JointGenericAxis
-
-            pre_H_suc = jaxlie.SE3.from_rotation_and_translation(
-                rotation=jaxlie.SO3.identity(),
-                translation=jnp.array(s * joint_type.axis),
-            )
+        S = jnp.vstack(jnp.hstack([jnp.zeros(3), joint_axis.squeeze()]))
+        return pre_H_suc, S
 
-            S = jnp.vstack(jnp.hstack([joint_type.axis.squeeze(), jnp.zeros(3)]))
+    def compute_P():
+        pre_H_suc = jaxlie.SE3.from_rotation_and_translation(
+            rotation=jaxlie.SO3.identity(),
+            translation=jnp.array(s * joint_axis),
+        )
 
-        case JointType.F:
-            pre_H_suc = jaxlie.SE3.identity()
-            S = jnp.zeros(shape=(6, 1))
+        S = jnp.vstack(jnp.hstack([joint_axis.squeeze(), jnp.zeros(3)]))
+        return pre_H_suc, S
 
-        case _:
-            raise ValueError(joint_type)
+    pre_H_suc, S = jax.lax.switch(
+        index=joint_type,
+        branches=(
+            compute_F,  # JointType.Fixed
+            compute_R,  # JointType.Revolute
+            compute_P,  # JointType.Prismatic
+        ),
+    )
 
     return pre_H_suc.as_matrix(), S

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/parsers/descriptions/__init__.py

@@ -1,4 +1,4 @@
 from .collision import BoxCollision, CollidablePoint, CollisionShape, SphereCollision
-from .joint import JointDescription, JointDescriptor, JointGenericAxis, JointType
+from .joint import JointDescription, JointGenericAxis, JointType
 from .link import LinkDescription
 from .model import ModelDescription

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/parsers/descriptions/joint.py

@@ -1,8 +1,7 @@
 from __future__ import annotations
 
 import dataclasses
-import enum
-from typing import Tuple, Union
+from typing import ClassVar, Tuple, Union
 
 import jax_dataclasses
 import numpy as np
@@ -14,39 +13,15 @@ from jaxsim.utils import JaxsimDataclass, Mutability
 from .link import LinkDescription
 
 
-@enum.unique
-class JointType(enum.IntEnum):
-    """
-    Type of supported joints.
-    """
-
-    @staticmethod
-    def _generate_next_value_(name, start, count, last_values):
-        # Start auto Enum value from 0 instead of 1
-        return count
-
-    #: Fixed joint.
-    F = enum.auto()
-
-    #: Revolute joint (1 DoF around axis).
-    R = enum.auto()
-
-    #: Prismatic joint (1 DoF along axis).
-    P = enum.auto()
-
-
-@jax_dataclasses.pytree_dataclass
-class JointDescriptor:
-    """
-    Base class for joint types requiring to store additional metadata.
-    """
-
-    #: The joint type.
-    joint_type: JointType
+@dataclasses.dataclass(frozen=True)
+class JointType:
+    Fixed: ClassVar[int] = 0
+    Revolute: ClassVar[int] = 1
+    Prismatic: ClassVar[int] = 2
 
 
 @jax_dataclasses.pytree_dataclass
-class JointGenericAxis(JointDescriptor):
+class JointGenericAxis:
     """
     A joint requiring the specification of a 3D axis.
     """
@@ -55,7 +30,7 @@ class JointGenericAxis(JointDescriptor):
     axis: jtp.Vector
 
     def __hash__(self) -> int:
-        return hash((self.joint_type, tuple(np.array(self.axis).tolist())))
+        return hash((tuple(np.array(self.axis).tolist())))
 
     def __eq__(self, other: JointGenericAxis) -> bool:
         if not isinstance(other, JointGenericAxis):
@@ -73,7 +48,7 @@ class JointDescription(JaxsimDataclass):
         name (str): The name of the joint.
         axis (npt.NDArray): The axis of rotation or translation for the joint.
         pose (npt.NDArray): The pose transformation matrix of the joint.
-        jtype (Union[JointType, JointDescriptor]): The type of the joint.
+        jtype (JointType): The type of the joint.
         child (LinkDescription): The child link attached to the joint.
         parent (LinkDescription): The parent link attached to the joint.
         index (Optional[int]): An optional index for the joint.
@@ -89,7 +64,7 @@ class JointDescription(JaxsimDataclass):
     name: jax_dataclasses.Static[str]
     axis: npt.NDArray
     pose: npt.NDArray
-    jtype: jax_dataclasses.Static[Union[JointType, JointDescriptor]]
+    jtype: jax_dataclasses.Static[JointType]
     child: LinkDescription = dataclasses.dataclass(repr=False)
     parent: LinkDescription = dataclasses.dataclass(repr=False)
 

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/parsers/kinematic_graph.py

@@ -689,6 +689,7 @@ class KinematicGraphTransforms:
             # Compute the joint transform from the predecessor to the successor frame.
             pre_H_J = self.pre_H_suc(
                 joint_type=joint.jtype,
+                joint_axis=joint.axis,
                 joint_position=self._initial_joint_positions[joint.name],
             )
 
@@ -762,14 +763,15 @@ class KinematicGraphTransforms:
 
     @staticmethod
     def pre_H_suc(
-        joint_type: descriptions.JointType | descriptions.JointDescriptor,
+        joint_type: descriptions.JointType,
+        joint_axis: descriptions.JointGenericAxis,
         joint_position: float | None = None,
     ) -> npt.NDArray:
 
         import jaxsim.math
 
         return np.array(
-            jaxsim.math.supported_joint_motion(
-                joint_type=joint_type, joint_position=joint_position
-            )[0]
+            jaxsim.math.supported_joint_motion(joint_type, joint_position, joint_axis)[
+                0
+            ]
         )

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/parsers/rod/parser.py

@@ -352,7 +352,7 @@ def build_model_description(
         considered_joints=[
             j.name
             for j in sdf_data.joint_descriptions
-            if j.jtype is not descriptions.JointType.F
+            if j.jtype is not descriptions.JointType.Fixed
         ],
     )
 

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim/parsers/rod/utils.py

@@ -61,7 +61,7 @@ def from_sdf_inertial(inertial: rod.Inertial) -> jtp.Matrix:
 
 def joint_to_joint_type(
     joint: rod.Joint,
-) -> descriptions.JointType | descriptions.JointDescriptor:
+) -> descriptions.JointType:
     """
     Extract the joint type from an SDF joint.
 
@@ -76,7 +76,7 @@ def joint_to_joint_type(
     joint_type = joint.type
 
     if joint_type == "fixed":
-        return descriptions.JointType.F
+        return descriptions.JointType.Fixed
 
     if not (axis.xyz is not None and axis.xyz.xyz is not None):
         raise ValueError("Failed to read axis xyz data")
@@ -86,14 +86,10 @@ def joint_to_joint_type(
     axis_xyz = axis_xyz / np.linalg.norm(axis_xyz)
 
     if joint_type in {"revolute", "continuous"}:
-        return descriptions.JointGenericAxis(
-            joint_type=descriptions.JointType.R, axis=axis_xyz
-        )
+        return descriptions.JointType.Revolute
 
     if joint_type == "prismatic":
-        return descriptions.JointGenericAxis(
-            joint_type=descriptions.JointType.P, axis=axis_xyz
-        )
+        return descriptions.JointType.Prismatic
 
     raise ValueError("Joint not supported", axis_xyz, joint_type)
 

{jaxsim-0.2.1.dev38 → jaxsim-0.2.1.dev47}/src/jaxsim.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jaxsim
-Version: 0.2.1.dev38
+Version: 0.2.1.dev47
 Home-page: https://github.com/ami-iit/jaxsim
 Author: Diego Ferigo
 Author-email: diego.ferigo@iit.it

jaxsim-0.2.1.dev38/examples/README.md

@@ -1,37 +0,0 @@
-# JAXsim Notebook Examples
-
-This folder includes a Jupyter Notebook demonstrating the practical usage of JAXsim for system simulations.
-
-### Examples
-
-- [PD_controller](https://colab.research.google.com/github/ami-iit/jaxsim/blob/main/examples/PD_controller.ipynb) - A simple example demonstrating the use of JAXsim to simulate a PD controller with gravity compensation for a 2-DOF cartpole.
-- [Parallel_computing](https://colab.research.google.com/github/ami-iit/jaxsim/blob/main/examples/Parallel_computing.ipynb) - An example demonstrating how to simulate vectorized models in parallel using JAXsim.
-
-> [!TIP]
-> Stay tuned for more examples!
-
-## Running the Examples
-
-To execute these examples utilizing JAXsim with hardware acceleration, there are a couple of options available:
-
-### Option 1: Google Colab (Recommended)
-
-The simplest way to run the examples is by accessing the provided Google Colab notebook link mentioned above. This will enable you to execute the examples in a hosted environment.
-
-### Option 2: Local Execution with `pixi`
-
-For local execution, follow these steps:
-
-1. **Install `pixi`:**
-
-As per the [official documentation](https://pixi.sh/#installation):
-
-```bash
-curl -fsSL https://pixi.sh/install.sh | bash
-```
-
-2. **Run the Example Notebook:**
-
-Use `pixi run examples` from the project source directory to execute the example notebook locally.
-
-This command will automatically handle the installation of necessary dependencies and execute the examples within a self-contained environment