jaxsim 0.7.1.dev67__py3-none-any.whl → 0.7.1.dev74__py3-none-any.whl

jaxsim/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.1.dev67'
-__version_tuple__ = version_tuple = (0, 7, 1, 'dev67')
+__version__ = version = '0.7.1.dev74'
+__version_tuple__ = version_tuple = (0, 7, 1, 'dev74')

{jaxsim-0.7.1.dev67.dist-info → jaxsim-0.7.1.dev74.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxsim
-Version: 0.7.1.dev67
+Version: 0.7.1.dev74
 Summary: A differentiable physics engine and multibody dynamics library for control and robot learning.
 Author-email: Diego Ferigo <dgferigo@gmail.com>, Filippo Luca Ferretti <filippoluca.ferretti@outlook.com>
 Maintainer-email: Filippo Luca Ferretti <filippo.ferretti@iit.it>, Alessandro Croci <alessandro.croci@iit.it>
@@ -63,31 +63,44 @@ Dynamic: license-file
 
 # JaxSim
 
-**JaxSim** is a **differentiable physics engine** and **multibody dynamics library** built with JAX, tailored for control and robotic learning applications.
+**JaxSim** is a **differentiable physics engine** built with JAX, tailored for co-design and robotic learning applications.
 
 <div align="center">
 <br/>
 <table>
   <tr>
-    <th><img src="https://github.com/user-attachments/assets/f9661fae-9a85-41dd-9a58-218758ec8c9c"></th>
-    <th><img src="https://github.com/user-attachments/assets/62b88b9d-45ea-4d22-99d2-f24fc842dd29"></th>
+    <th><img src="https://github.com/user-attachments/assets/89d0b4ca-7e0c-4f58-bf3e-9540e35b9a01" style="height:300px; width:400px; object-fit:cover;"></th>
+    <th><img src="https://github.com/user-attachments/assets/a909e388-d7b4-4b58-89f1-035da8636d94" style="height:300px; width:400px; object-fit:cover;"></th>
+  </tr>
+  <tr>
+    <th><img src="https://github.com/user-attachments/assets/3692bc06-18ed-406d-80bd-480780346224" style="height:300px; width:400px; object-fit:cover;"></th>
+    <th><img src="https://github.com/user-attachments/assets/3356f332-4710-4946-9a82-a8c2305dab88" style="height:300px; width:400px; object-fit:cover;"></th>
   </tr>
 </table>
 <br/>
 </div>
 
+
+
 ## Features
+
+- Physically consistent differentiability w.r.t. hardware parameters.
+- Closed chain dynamics support.
 - Reduced-coordinate physics engine for **fixed-base** and **floating-base** robots.
-- Multibody dynamics library for model-based control algorithms.
 - Fully Python-based, leveraging [jax][jax] following a functional programming paradigm.
 - Seamless execution on CPUs, GPUs, and TPUs.
 - Supports JIT compilation and automatic vectorization for high performance.
 - Compatible with SDF models and URDF (via [sdformat][sdformat] conversion).
 
-## Usage
 
-### Using JaxSim as simulator
+> [!WARNING]
+> This project is still experimental, APIs could change between releases without notice.
 
+> [!NOTE]
+> JaxSim currently focuses on locomotion applications.
+> Only contacts between bodies and smooth ground surfaces are supported.
+
+## How to use it
 
 ```python
 import pathlib
@@ -136,82 +149,13 @@ for _ in T:
     )
 ```
 
-### Using JaxSim as a multibody dynamics library
-``` python
-import pathlib
-
-import icub_models
-import jax.numpy as jnp
-
-import jaxsim.api as js
-
-# Load the iCub model
-model_path = icub_models.get_model_file("iCubGazeboV2_5")
-
-joints = ('torso_pitch', 'torso_roll', 'torso_yaw', 'l_shoulder_pitch',
-          'l_shoulder_roll', 'l_shoulder_yaw', 'l_elbow', 'r_shoulder_pitch',
-          'r_shoulder_roll', 'r_shoulder_yaw', 'r_elbow', 'l_hip_pitch',
-          'l_hip_roll', 'l_hip_yaw', 'l_knee', 'l_ankle_pitch', 'l_ankle_roll',
-          'r_hip_pitch', 'r_hip_roll', 'r_hip_yaw', 'r_knee', 'r_ankle_pitch',
-          'r_ankle_roll')
-
-# Build and reduce the model
-model_description = pathlib.Path(model_path)
-
-full_model = js.model.JaxSimModel.build_from_model_description(
-    model_description=model_description, time_step=0.0001, is_urdf=True
-)
-
-model = js.model.reduce(model=full_model, considered_joints=joints)
-
-# Initialize model data
-data = js.data.JaxSimModelData.build(
-    model=model,
-    base_position=jnp.array([0.0, 0.0, 1.0]),
-)
-
-# Frame and dynamics computations
-frame_index = js.frame.name_to_idx(model=model, frame_name="l_foot")
-
-# Frame transformation
-W_H_F = js.frame.transform(
-    model=model, data=data, frame_index=frame_index
-)
-
-# Frame Jacobian
-W_J_F = js.frame.jacobian(
-    model=model, data=data, frame_index=frame_index
-)
-
-# Dynamics properties
-M = js.model.free_floating_mass_matrix(model=model, data=data)  # Mass matrix
-h = js.model.free_floating_bias_forces(model=model, data=data)  # Bias forces
-g = js.model.free_floating_gravity_forces(model=model, data=data)  # Gravity forces
-C = js.model.free_floating_coriolis_matrix(model=model, data=data)  # Coriolis matrix
-
-# Print dynamics results
-print(f"{M.shape=} \n{h.shape=} \n{g.shape=} \n{C.shape=}")
-```
-
-### Additional features
-
-- Full support for automatic differentiation of RBDAs (forward and reverse modes) with JAX.
-- Support for automatically differentiating against kinematics and dynamics parameters.
-- All fixed-step integrators are forward and reverse differentiable.
-- Check the example folder for additional use cases!
+Check the example folder for additional use cases!
 
 [jax]: https://github.com/google/jax/
 [sdformat]: https://github.com/gazebosim/sdformat
 [notation]: https://research.tue.nl/en/publications/multibody-dynamics-notation-version-2
 [passive_viewer_mujoco]: https://mujoco.readthedocs.io/en/stable/python.html#passive-viewer
 
-> [!WARNING]
-> This project is still experimental, APIs could change between releases without notice.
-
-> [!NOTE]
-> JaxSim currently focuses on locomotion applications.
-> Only contacts between bodies and smooth ground surfaces are supported.
-
 ## Installation
 
 <details>
@@ -335,70 +279,66 @@ The JaxSim API documentation is available at [jaxsim.readthedocs.io][readthedocs
 
 [readthedocs]: https://jaxsim.readthedocs.io/
 
+## Additional features
+Jaxsim can also be used as a multi-body dynamic library!  With full support for automatic differentiation of RBDAs (forwards and reverse mode) and  automatic differentiation against both kinematic and dynamic parameters.
 
-## Overview
 
-<details>
-<summary>Structure of the Python package</summary>
+### Using JaxSim as a multibody dynamics library
+``` python
+import pathlib
 
-```
-# tree -L 2 -I "__pycache__" -I "__init__*" -I "__main__*" src/jaxsim
-
-src/jaxsim
-|-- api..........................# Package containing the main functional APIs.
-|   |-- actuation_model.py.......# |-- APIs for computing quantities related to the actuation model.
-|   |-- common.py................# |-- Common utilities used in the current package.
-|   |-- com.py...................# |-- APIs for computing quantities related to the center of mass.
-|   |-- contact_model.py.........# |-- APIs for computing quantities related to the contact model.
-|   |-- contact.py...............# |-- APIs for computing quantities related to the collidable points.
-|   |-- data.py..................# |-- Class storing the data of a simulated model.
-|   |-- frame.py.................# |-- APIs for computing quantities related to additional frames.
-|   |-- integrators.py...........# |-- APIs for integrating the system dynamics.
-|   |-- joint.py.................# |-- APIs for computing quantities related to the joints.
-|   |-- kin_dyn_parameters.py....# |-- Class storing kinematic and dynamic parameters of a model.
-|   |-- link.py..................# |-- APIs for computing quantities related to the links.
-|   |-- model.py.................# |-- Class defining a simulated model and APIs for computing related quantities.
-|   |-- ode.py...................# |-- APIs for computing quantities related to the system dynamics.
-|   `-- references.py............# `-- Helper class to create references (link forces and joint torques).
-|-- exceptions.py................# Module containing functions to raise exceptions from JIT-compiled functions.
-|-- logging.py...................# Module containing logging utilities.
-|-- math.........................# Package containing mathematical utilities.
-|   |-- adjoint.py...............# |-- APIs for creating and manipulating 6D transformations.
-|   |-- cross.py.................# |-- APIs for computing cross products of 6D quantities.
-|   |-- inertia.py...............# |-- APIs for creating and manipulating 6D inertia matrices.
-|   |-- joint_model.py...........# |-- APIs defining the supported joint model and the corresponding transformations.
-|   |-- quaternion.py............# |-- APIs for creating and manipulating quaternions.
-|   |-- rotation.py..............# |-- APIs for creating and manipulating rotation matrices.
-|   |-- skew.py..................# |-- APIs for creating and manipulating skew-symmetric matrices.
-|   |-- transform.py.............# |-- APIs for creating and manipulating homogeneous transformations.
-|   |-- utils.py.................# |-- Common utilities used in the current package.
-|-- mujoco.......................# Package containing utilities to interact with the Mujoco passive viewer.
-|   |-- loaders.py...............# |-- Utilities for converting JaxSim models to Mujoco models.
-|   |-- model.py.................# |-- Class providing high-level methods to compute quantities using Mujoco.
-|   `-- visualizer.py............# `-- Class that simplifies opening the passive viewer and recording videos.
-|-- parsers......................# Package containing utilities to parse model descriptions (SDF and URDF models).
-|   |-- descriptions/............# |-- Package containing the intermediate representation of a model description.
-|   |-- kinematic_graph.py.......# |-- Definition of the kinematic graph associated with a parsed model description.
-|   `-- rod/.....................# `-- Package to create the intermediate representation from model descriptions using ROD.
-|-- rbda.........................# Package containing the low-level rigid body dynamics algorithms.
-|   |-- aba.py...................# |-- The Articulated Body Algorithm.
-|   |-- collidable_points.py.....# |-- Kinematics of collidable points.
-|   |-- contacts/................# |-- Package containing the supported contact models.
-|   |-- crba.py..................# |-- The Composite Rigid Body Algorithm.
-|   |-- forward_kinematics.py....# |-- Forward kinematics of the model.
-|   |-- jacobian.py..............# |-- Full Jacobian and full Jacobian derivative.
-|   |-- rnea.py..................# |-- The Recursive Newton-Euler Algorithm.
-|   `-- utils.py.................# `-- Common utilities used in the current package.
-|-- terrain......................# Package containing resources to specify the terrain.
-|   `-- terrain.py...............# `-- Classes defining the supported terrains.
-|-- typing.py....................# Module containing type hints.
-`-- utils........................# Package of common utilities.
-    |-- jaxsim_dataclass.py......# |-- Utilities to operate on pytree dataclasses.
-    |-- tracing.py...............# |-- Utilities to use when JAX is tracing functions.
-    `-- wrappers.py..............# `-- Utilities to wrap objects for specific use cases on pytree dataclass attributes.
-```
+import icub_models
+import jax.numpy as jnp
 
-</details>
+import jaxsim.api as js
+
+# Load the iCub model
+model_path = icub_models.get_model_file("iCubGazeboV2_5")
+
+joints = ('torso_pitch', 'torso_roll', 'torso_yaw', 'l_shoulder_pitch',
+          'l_shoulder_roll', 'l_shoulder_yaw', 'l_elbow', 'r_shoulder_pitch',
+          'r_shoulder_roll', 'r_shoulder_yaw', 'r_elbow', 'l_hip_pitch',
+          'l_hip_roll', 'l_hip_yaw', 'l_knee', 'l_ankle_pitch', 'l_ankle_roll',
+          'r_hip_pitch', 'r_hip_roll', 'r_hip_yaw', 'r_knee', 'r_ankle_pitch',
+          'r_ankle_roll')
+
+# Build and reduce the model
+model_description = pathlib.Path(model_path)
+
+full_model = js.model.JaxSimModel.build_from_model_description(
+    model_description=model_description, time_step=0.0001, is_urdf=True
+)
+
+model = js.model.reduce(model=full_model, considered_joints=joints)
+
+# Initialize model data
+data = js.data.JaxSimModelData.build(
+    model=model,
+    base_position=jnp.array([0.0, 0.0, 1.0]),
+)
+
+# Frame and dynamics computations
+frame_index = js.frame.name_to_idx(model=model, frame_name="l_foot")
+
+# Frame transformation
+W_H_F = js.frame.transform(
+    model=model, data=data, frame_index=frame_index
+)
+
+# Frame Jacobian
+W_J_F = js.frame.jacobian(
+    model=model, data=data, frame_index=frame_index
+)
+
+# Dynamics properties
+M = js.model.free_floating_mass_matrix(model=model, data=data)  # Mass matrix
+h = js.model.free_floating_bias_forces(model=model, data=data)  # Bias forces
+g = js.model.free_floating_gravity_forces(model=model, data=data)  # Gravity forces
+C = js.model.free_floating_coriolis_matrix(model=model, data=data)  # Coriolis matrix
+
+# Print dynamics results
+print(f"{M.shape=} \n{h.shape=} \n{g.shape=} \n{C.shape=}")
+```
 
 ## Credits
 

{jaxsim-0.7.1.dev67.dist-info → jaxsim-0.7.1.dev74.dist-info}/RECORD

@@ -1,5 +1,5 @@
 jaxsim/__init__.py,sha256=EKeysKN-7UswwJLCl7n6qIBKQIVUtYsCMYu_tCoFn7g,3628
-jaxsim/_version.py,sha256=lpdTbG3YGqsTW99QEMoIM2-xJyn_Dn0BtpgLEgp87Pg,526
+jaxsim/_version.py,sha256=pCLQbCXpNozmRe1kt1RDq6Enlt2AEbJJaf53Ij3sVN0,526
 jaxsim/exceptions.py,sha256=MQ3LRMfVMX2-g3qYj7mUVNV9OLlIA48TANJegbcQyXI,2641
 jaxsim/logging.py,sha256=STI-D_upXZYX-ZezLrlJJ0UlD5YspST0vZ_DcIwkzO4,1553
 jaxsim/typing.py,sha256=7msl8t5Jt09RNYfKdPJtpjLfWurldcycDappb045Eso,761
@@ -66,8 +66,8 @@ jaxsim/utils/__init__.py,sha256=Y5zyoRevl3EMVQadhZ4EtSwTEkDt2vcnFoRhPJjKTZ0,215
 jaxsim/utils/jaxsim_dataclass.py,sha256=XzmZeIibcaOzaxpprsGSxH3UrM66PAO456rFV91sNXg,11453
 jaxsim/utils/tracing.py,sha256=Btwxdfhb7fJLk3r5PlQkGYj60Y2KbFT1gANGIA697FU,530
 jaxsim/utils/wrappers.py,sha256=3IMwydqFgmSPqeuUQ3PRmdhDc1IoT6XC23jPC_LjWXs,4175
-jaxsim-0.7.1.dev67.dist-info/licenses/LICENSE,sha256=eaYdFmdeMbiIoIiPzEK0MjP1S9wtFXjXNR5er49uLR0,1546
-jaxsim-0.7.1.dev67.dist-info/METADATA,sha256=7v2LSaRywF24f2A9JQhgum9D0VLTs-CZ1zj7UXkTVa0,18639
-jaxsim-0.7.1.dev67.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-jaxsim-0.7.1.dev67.dist-info/top_level.txt,sha256=LxGMA8FLtXjQ6oI7N5gd_R_oSUHxpXxUEOfT1xS_ni0,7
-jaxsim-0.7.1.dev67.dist-info/RECORD,,
+jaxsim-0.7.1.dev74.dist-info/licenses/LICENSE,sha256=eaYdFmdeMbiIoIiPzEK0MjP1S9wtFXjXNR5er49uLR0,1546
+jaxsim-0.7.1.dev74.dist-info/METADATA,sha256=xwGW7dxTFE1_tYK31AY50GFpcudug0Azyrnmnl8YSeY,14086
+jaxsim-0.7.1.dev74.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jaxsim-0.7.1.dev74.dist-info/top_level.txt,sha256=LxGMA8FLtXjQ6oI7N5gd_R_oSUHxpXxUEOfT1xS_ni0,7
+jaxsim-0.7.1.dev74.dist-info/RECORD,,