Skip to main content

A physics engine in reduced coordinates implemented with JAX.

Project description

JAXsim

A scalable physics engine implemented with JAX. With JIT batteries 🔋

⚠ This project is still experimental, APIs could change without notice. ️⚠

⚠ This simulator currently focuses on locomotion applications. Only contacts with ground are supported. ️⚠

Features

  • Physics engine in reduced coordinates implemented with JAX in Python.
  • Supported JIT compilation of Python code for increased performance.
  • Transparent support to execute the simulation on CPUs, GPUs, and TPUs.
  • Possibility to run parallel multi-body simulations on hardware accelerators for significantly increased throughput.
  • Support of SDF models (and, upon conversion, URDF models).
  • Collision detection between bodies and uneven ground surface.
  • Continuous soft contacts model with no friction cone approximations.
  • Full support of inertial properties of bodies.
  • Revolute, prismatic, and fixed joints support.
  • Integrators: forward Euler, semi-implicit Euler, Runge-Kutta 4.
  • High-level classes to compute multi-body dynamics quantities from simulation state.
  • High-level classes supporting both object-oriented and functional programming.
  • Optional validation of JAX pytrees to prevent JIT re-compilation.

Planned features:

  • Reinforcement Learning module developed in JAX.
  • Finalization of differentiable physics through the simulation.

Installation

You can install the project with pypa/pip, preferably in a virtual environment:

pip install jaxsim

Have a look to setup.cfg for a complete list of optional dependencies. You can install all of them by specifying jaxsim[all].

Note: if you need GPU support, please follow the official installation instruction of JAX.

Credits

The physics module of JAXsim is based on the theory of the Rigid Body Dynamics Algorithms book authored by Roy Featherstone. We structured part of our logic following its accompanying code. The physics engine is developed entirely in Python using JAX.

The inspiration of developing JAXsim stems from google/brax. Here below we summarize the differences between the projects:

  • JAXsim simulates multibody dynamics in reduced coordinates, while brax uses maximal coordinates.
  • The rigid body algorithms used in JAXsim allow to efficiently compute quantities based on the Euler-Poincarè formulation of the equations of motion, necessary for model-based robotics research.
  • JAXsim supports SDF (and, indirectly, URDF) models, under the assumption that the model is described with the recent Pose Frame Semantics.
  • Contrarily to brax, JAXsim only supports collision detection between bodies and a compliant ground surface.
  • While supported thanks to the usage of JAX, differentiating through the simulator has not yet been studied.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Citing

@software{ferigo_jaxsim_2022,
  author = {Diego Ferigo and Silvio Traversaro and Daniele Pucci},
  title = {{JAXsim}: A Physics Engine in Reduced Coordinates for Control and Robot Learning},
  url = {http://github.com/ami-iit/jaxsin},
  year = {2022},
}

Maintainers

@diegoferigo

License

BSD3

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jaxsim-0.1.dev149.tar.gz (55.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jaxsim-0.1.dev149-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

Details for the file jaxsim-0.1.dev149.tar.gz.

File metadata

  • Download URL: jaxsim-0.1.dev149.tar.gz
  • Upload date:
  • Size: 55.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for jaxsim-0.1.dev149.tar.gz
Algorithm Hash digest
SHA256 cda2fc61e0a6364d7d7fd05575b0090a4abc3b03581a60cd0807d5df2ada65d7
MD5 3319dde49d44052ebf8d04f9a3355cb4
BLAKE2b-256 8aa819a5a166b0fc6962dfb7c75c64c9d5a23eba0521ea6fdd3d5fc9e5e86e47

See more details on using hashes here.

File details

Details for the file jaxsim-0.1.dev149-py3-none-any.whl.

File metadata

  • Download URL: jaxsim-0.1.dev149-py3-none-any.whl
  • Upload date:
  • Size: 68.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for jaxsim-0.1.dev149-py3-none-any.whl
Algorithm Hash digest
SHA256 ec23cbc9a4603dd491589f55b6e86fa743829080c385c1fe75f9241a92d8048c
MD5 605fd2c6647143926e8fca479662fcf2
BLAKE2b-256 dccf9f5a9e7ea02713c273aa0a3a45d55d85dd0625fe931b0a2dd9577ad937d0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page