Skip to main content

Efficient rigid body dynamics (python bindings)

Project description

Pinocchio Logo

License Coverage Report Conda Downloads Conda Version PyPI version

Pinocchio instantiates the state-of-the-art Rigid Body Algorithms for poly-articulated systems based on revisited Roy Featherstone's algorithms. Besides, Pinocchio provides the analytical derivatives of the main Rigid-Body Algorithms like the Recursive Newton-Euler Algorithm or the Articulated-Body Algorithm.

Pinocchio is first tailored for robotics applications, but it can be used in extra contexts (biomechanics, computer graphics, vision, etc.). It is built upon Eigen for linear algebra and FCL for collision detection. Pinocchio comes with a Python interface for fast code prototyping, directly accessible through Conda.

Pinocchio is now at the heart of various robotics softwares as Crocoddyl, an open-source and efficient Differential Dynamic Programming solver for robotics, the Stack-of-Tasks, an open-source and versatile hierarchical controller framework or the Humanoid Path Planner, an open-source software for Motion and Manipulation Planning.

If you want to learn more on Pinocchio internal behaviors and main features, we invite you to read the related paper.

If you want to directly dive into Pinocchio, only one single line is sufficient (assuming you have Conda):

conda install pinocchio -c conda-forge

or via pip (currently only available on Linux):

pip install pin

Pinocchio main features

Pinocchio is fast:

  • C++ template library,
  • cache friendly,
  • automatic code generation support via CppADCodeGen.

Pinocchio is versatile, implementing basic and more advanced rigid body dynamics algorithms:

  • forward kinematics and its analytical derivatives,
  • forward/inverse dynamics and their analytical derivatives,
  • centroidal dynamics and its analytical derivatives,
  • support of multiple precision arithmetic via Boost.Multiprecision or any similar framework,
  • computations of kinematic and dynamic regressors for system identification and more,
  • and much more with the support of modern and open source Automatic Differentiation frameworks like CppAD or CasADi.

Pinocchio is flexible:

  • header only,
  • C++ 98/03/11/14/17/20 compliant.

Pinocchio is extensible. Pinocchio is multi-thread friendly. Pinocchio is reliable and extensively tested (unit-tests, simulations and real world robotics applications). Pinocchio is supported and tested on Windows, Mac OS X, Unix and Linux (see build status here).

Pinocchio continuous integrations

Pinocchio is constantly tested for several platforms and distributions, as reported below:

CI on ROS ROS
CI on Linux via APT linux
CI on OSX via Conda mac
CI on Windows via Conda windows
CI on Linux via Robotpkg Pipeline Status

Performances

Pinocchio exploits at best the sparsity induced by the kinematic tree of robotics systems. Thanks to modern programming language paradigms, Pinocchio is able to unroll most of the computations directly at compile time, allowing to achieve impressive performances for a large range of robots, as illustrated by the plot below, obtained on a standard laptop equipped with an Intel Core i7 CPU @ 2.4 GHz.

Pinocchio Logo

For other benchmarks, and mainly the capacity of Pinocchio to exploit at best your CPU capacities using advanced code generation techniques, we refer to the technical paper. In addition, the introspection done here may also help you to understand and compare the performances of the modern rigid body dynamics librairies.

Ongoing developments

If you want to follow the current developments, you can directly refer to the devel branch. The master branch only contains latest release. Any new Pull Request should then be submitted on the devel branch.

Installation

Pinocchio can be easily installed on various Linux (Ubuntu, Fedora, etc.) and Unix distributions (Mac OS X, BSD, etc.). Please refer to the installation procedure.

If you only need the Python bindings of Pinocchio, you may prefer to install it through Conda. Please follow the procedure described here.

Pinocchio is also deployed on ROS, you may follow its deployment status on Melodic or Kinetic.

Documentation

The online Pinocchio documentation of the last release is available here.

Examples

We provide some basic examples on how to use Pinocchio in Python in the examples/python directory. Additional examples introducing Pinocchio are also available in the documentation.

Tutorials

Pinocchio comes with a large bunch of tutorials aiming at introducing the basic tools for robot control. The content of the tutorials is described here. Additionnal materials were presented during the Memmo summer school and available here.

Visualization

Pinocchio provides support for many open-source and free visualizers:

  • Gepetto Viewer: a C++ viewer based on OpenSceneGraph with Python bindings and Blender export. See here for a C++ example on mixing Pinocchio and Gepetto Viewer.
  • Meshcat: supporting visualization in Python and which can be embeded inside any browser.
  • Panda3d: supporting visualization in Python and which can be embeded inside any browser.
  • RViz: supporting visualization in Python and which can interact with other ROS packages.

Many external viewers can also be integrated. See example here for more information.

Citing Pinocchio

To cite Pinocchio in your academic research, please use the following bibtex lines:

@misc{pinocchioweb,
   author = {Justin Carpentier and Florian Valenza and Nicolas Mansard and others},
   title = {Pinocchio: fast forward and inverse dynamics for poly-articulated systems},
   howpublished = {https://stack-of-tasks.github.io/pinocchio},
   year = {2015--2021}
}

and the following one for the reference to the paper introducing Pinocchio:

@inproceedings{carpentier2019pinocchio,
   title={The Pinocchio C++ library -- A fast and flexible implementation of rigid body dynamics algorithms and their analytical derivatives},
   author={Carpentier, Justin and Saurel, Guilhem and Buondonno, Gabriele and Mirabel, Joseph and Lamiraux, Florent and Stasse, Olivier and Mansard, Nicolas},
   booktitle={IEEE International Symposium on System Integrations (SII)},
   year={2019}
}

The algorithms for the analytical derivatives of rigid-body dynamics algorithms are detailed here:

@inproceedings{carpentier2018analytical,
  title = {Analytical Derivatives of Rigid Body Dynamics Algorithms},
  author = {Carpentier, Justin and Mansard, Nicolas},
  booktitle = {Robotics: Science and Systems},
  year = {2018}
}

Questions and Issues

You have a question or an issue? You may either directly open a new issue or use the mailing list pinocchio@laas.fr.

Credits

The following people have been involved in the development of Pinocchio and are warmly thanked for their contributions:

If you have taken part to the development of Pinocchio, feel free to add your name and contribution in this list.

Acknowledgments

The development of Pinocchio is actively supported by the Gepetto team @LAAS-CNRS and the Willow team @INRIA.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

pin-2.6.4-1-cp39-cp39-manylinux_2_24_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.24+ x86-64

pin-2.6.4-1-cp38-cp38-manylinux_2_24_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.8manylinux: glibc 2.24+ x86-64

pin-2.6.4-1-cp37-cp37m-manylinux_2_24_x86_64.whl (5.6 MB view details)

Uploaded CPython 3.7mmanylinux: glibc 2.24+ x86-64

pin-2.6.4-1-cp36-cp36m-manylinux_2_24_x86_64.whl (5.6 MB view details)

Uploaded CPython 3.6mmanylinux: glibc 2.24+ x86-64

pin-2.6.4-1-cp27-cp27mu-manylinux_2_24_x86_64.whl (5.6 MB view details)

Uploaded CPython 2.7mumanylinux: glibc 2.24+ x86-64

File details

Details for the file pin-2.6.4-1-cp39-cp39-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: pin-2.6.4-1-cp39-cp39-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.9, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for pin-2.6.4-1-cp39-cp39-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 086ec41e3a59c82f00f2670da1145def8a5e15c4e1d1ad54dca86f9b9cab87bd
MD5 ea0f3e8f365fa2bad696496a04ed57ba
BLAKE2b-256 778c65e121770e9a9b05f14af81bc01865324d61be7593d94093d705f7680ddb

See more details on using hashes here.

File details

Details for the file pin-2.6.4-1-cp38-cp38-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: pin-2.6.4-1-cp38-cp38-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.8, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for pin-2.6.4-1-cp38-cp38-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 01c8482d5d7fb2ae61f49c2407f4a1a07c42840728d91155c0bdd20588c5e5e1
MD5 8bf6ad3f9ad7f576e50836b28a119bc3
BLAKE2b-256 d37a86c82ca5a3975cc3a82c33b9ab994b256ceb34077ba24e3c61905b47aa49

See more details on using hashes here.

File details

Details for the file pin-2.6.4-1-cp37-cp37m-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: pin-2.6.4-1-cp37-cp37m-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 5.6 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for pin-2.6.4-1-cp37-cp37m-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 8564879b0b41fb8cd934c1f31f619c6e61c86fc6172409d6243c99b5f605e6ee
MD5 f002b24d2d5a09619a6a8c5dcba51229
BLAKE2b-256 401f9adcc5bc7dca8d16fff5bfe08d7c836ccbb8adcd12771f83ec512bb6a54f

See more details on using hashes here.

File details

Details for the file pin-2.6.4-1-cp36-cp36m-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: pin-2.6.4-1-cp36-cp36m-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 5.6 MB
  • Tags: CPython 3.6m, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for pin-2.6.4-1-cp36-cp36m-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 6fcb2c64d7010eddcd058afe1fd50a4d493abe9b793251754e54027126b78a06
MD5 8c12dd751f653d442f230a1cceabdfc6
BLAKE2b-256 7d7ab3f07e4d2a2cf7154741e9cb04674ecc24c195db38ee47156b7a3af55655

See more details on using hashes here.

File details

Details for the file pin-2.6.4-1-cp27-cp27mu-manylinux_2_24_x86_64.whl.

File metadata

  • Download URL: pin-2.6.4-1-cp27-cp27mu-manylinux_2_24_x86_64.whl
  • Upload date:
  • Size: 5.6 MB
  • Tags: CPython 2.7mu, manylinux: glibc 2.24+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for pin-2.6.4-1-cp27-cp27mu-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 4cfc74f54f3f558244ed271c88088bd3d4f761d4cf215af8a8844464a4ef921a
MD5 9deb9fd23c8e6674554850fbd3aa7e68
BLAKE2b-256 75d24f8c10aa468a12414c529838fc4751fa16373ce2ccf583501e9a9e6f23aa

See more details on using hashes here.

Supported by

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