flo-wo / crocoddyl Goto Github PK

Crocoddyl is an optimal control library for robot control under contact sequence. Its solvers are based on novel and efficient Differential Dynamic Programming (DDP) algorithms. Crocoddyl computes optimal trajectories along with optimal feedback gains. It uses Pinocchio for fast computation of robots dynamics and their analytical derivatives.

The source code is released under the BSD 3-Clause license.

Authors: Carlos Mastalli and Rohan Budhiraja
Instructors: Nicolas Mansard
With additional support from the Gepetto team at LAAS-CNRS and MEMMO project. For more details see Section Credits

If you want to follow the current developments, you can directly refer to the devel branch. If you want to directly dive into Crocoddyl, only one single line is sufficient

conda install crocoddyl -c conda-forge

and if you prefer pip (in Python 3 or 2):

pip install --user crocoddyl

Crocoddyl can be easily installed on various Linux (Ubuntu, Fedora, etc.) and Unix distributions (Mac OS X, BSD, etc.).

Crocoddyl is versatible:

• various optimal control solvers (DDP, FDDP, BoxDDP, etc) - single and multi-shooting methods
• analytical and sparse derivatives via Pinocchio
• Euclidian and non-Euclidian geometry friendly via Pinocchio
• handle autonomous and nonautomous dynamical systems
• numerical differentiation support
• automatic differentiation support via CppAD

Crocoddyl is efficient and flexible:

• cache friendly,
• multi-thread friendly
• Python bindings (including models and solvers abstractions) via Boost Python
• C++ 14/17/20 compliant
• extensively tested
• automatic code generation support via CppADCodeGen

You can install this package through robotpkg. robotpkg is a package manager tailored for robotics softwares. It greatly simplifies the release of new versions along with the management of their dependencies. You just need to add the robotpkg apt repository to your sources.list and then use sudo apt install robotpkg-py27-crocoddyl (or py3X for python 3.X, depending on your system):

If you have never added robotpkg as a softwares repository, please follow first the instructions from 1 to 3; otherwise, go directly to instruction 4. Those instructions are similar to the installation procedures presented in http://robotpkg.openrobots.org/debian.html.

1. Add robotpkg as source repository to apt:

sudo tee /etc/apt/sources.list.d/robotpkg.list <<EOF
deb [arch=amd64] http://robotpkg.openrobots.org/wip/packages/debian/pub $(lsb_release -sc) robotpkg
deb [arch=amd64] http://robotpkg.openrobots.org/packages/debian/pub $(lsb_release -sc) robotpkg
EOF

2. Register the authentication certificate of robotpkg:

curl http://robotpkg.openrobots.org/packages/debian/robotpkg.key | sudo apt-key add -

3. You need to run at least once apt update to fetch the package descriptions:

sudo apt-get update

4. The installation of Crocoddyl:

sudo apt install robotpkg-py36-crocoddyl # for Python 3

sudo apt install robotpkg-py27-crocoddyl # for Python 2

Finally you will need to configure your environment variables, e.g.:

export PATH=/opt/openrobots/bin:$PATH
export PKG_CONFIG_PATH=/opt/openrobots/lib/pkgconfig:$PKG_CONFIG_PATH
export LD_LIBRARY_PATH=/opt/openrobots/lib:$LD_LIBRARY_PATH
export PYTHONPATH=/opt/openrobots/lib/python2.7/site-packages:$PYTHONPATH

Crocoddyl is c++ library with Python bindings for versatile and fast prototyping. It has the following dependencies:

• pinocchio
• Eigen
• eigenpy
• Boost
• example-robot-data (optional for examples, install Python loaders)
• OpenMP (optional for multi-threading installation)
• gepetto-viewer-corba (optional for display)
• jupyter (optional for notebooks)
• matplotlib (optional for examples)

You can run examples, unit-tests and benchmarks from your build dir:

cd build
make test
make -s examples-quadrupedal_gaits INPUT="display plot" # enable display and plot
make -s benchmarks-cpp-quadrupedal_gaits INPUT="100 walk" # number of trials ; type of gait

Alternatively, you can see the 3D result and/or graphs of your run examples (through gepetto-viewer and matplotlib), you can use

export CROCODDYL_DISPLAY=1
export CROCODDYL_PLOT=1

After installation, you could run the examples as follows:

python -m crocoddyl.examples.quadrupedal_gaits "display" "plot" # enable display and plot

If you want to learn about Crocoddyl, take a look at the Jupyter notebooks. Start in the following order.

• examples/notebooks/unicycle_towards_origin.ipynb
• examples/notebooks/cartpole_swing_up.ipynb
• examples/notebooks/arm_manipulation.ipynb
• examples/notebooks/whole_body_manipulation.ipynb
• examples/notebooks/bipedal_walking.ipynb
• examples/notebooks/introduction_to_crocoddyl.ipynb

The documentation of Crocoddyl of its last release is available here.

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

@inproceedings{mastalli20crocoddyl,
  author={Mastalli, Carlos and Budhiraja, Rohan and Merkt, Wolfgang and Saurel, Guilhem and Hammoud, Bilal
  and Naveau, Maximilien and Carpentier, Justin and Righetti, Ludovic and Vijayakumar, Sethu and Mansard, Nicolas},
  title={{Crocoddyl: An Efficient and Versatile Framework for Multi-Contact Optimal Control}},
  booktitle = {IEEE International Conference on Robotics and Automation (ICRA)},
  year={2020}
}

and the following one to reference this website:

@misc{crocoddylweb,
   author = {Carlos Mastalli, Rohan Budhiraja and Nicolas Mansard and others},
   title = {Crocoddyl: a fast and flexible optimal control library for robot control under contact sequence},
   howpublished = {https://github.com/loco-3d/crocoddyl/wikis/home},
   year = {2019}
}

Crocoddyl contributions go beyond efficient software implementation as well. Please also consider to cite the algorithm contributions of our different solvers and formulations:

• Feasibility-driven DDP (FDDP): [1]
• Control-limited feasibility-driven DDP (Box-FDDP): [2]
• Multi-phase rigid optimal control: [3]

Finally, please also consider citing Pinocchio, which contributes to the efficient implementation of rigid body algorithms and their derivatives. For more details how to cite Pinocchio visit: https://github.com/stack-of-tasks/pinocchio.

Below, there is list of the selected publications that describe different components of Crocoddyl. For a complete list see PUBLICATIONS.md.

[1] C. Mastalli, R. Budhiraja, W. Merkt, G. Saurel, B. Hammoud, M. Naveau, J. Carpentier, L. Righetti, S. Vijayakumar and N. Mansard. Crocoddyl: An Efficient and Versatile Framework for Multi-Contact Optimal Control, IEEE International Conference on Robotics and Automation (ICRA), 2020

[2] C. Mastalli, W. Merkt, J. Marti-Saumell, H. Ferrolho, J. Sola, N. Mansard, S. Vijayakumar. A Direct-Indirect Hybridization Approach to Control-Limited DDP, 2021

[3] R. Budhiraja, J. Carpentier, C. Mastalli and N. Mansard. Differential Dynamic Programming for Multi-Phase Rigid Contact Dynamics, IEEE RAS International Conference on Humanoid Robots (ICHR), 2018

You have a question or an issue? You may either directly open a new issue or use the mailing list [email protected].

Crocoddyl is being managed by a steering committee which meets every two weeks to discuss the ongoing developments.

The committee is being led by Carlos Mastalli (University of Edinburgh) and Rohan Budhiraja (LAAS-CNRS). Nicolas Mansard (LAAS-CNRS), Guilhem Saurel (LAAS-CNRS) and Justin Carpentier (INRIA) are other members of the committee.

The following people have been involved in the development of Crocoddyl:

• Nicolas Mansard (LAAS-CNRS): project instructor and main developer
• Carlos Mastalli (University of Edinburgh): main developer
• Rohan Budhiraja (LAAS-CNRS): main developer
• Justin Carpentier (INRIA): efficient analytical rigid-body dynamics derivatives, conda integration
• Andrea Del Prete (UNITN): feature extension
• Maximilien Naveau (MPI): unit-test support
• Guilhem Saurel (LAAS-CNRS): continuous integration and deployment
• Wolfgang Merkt (University of Oxford): feature extension and debugging
• Josep Martí Saumell (IRI: CSIC-UPC): feature extension
• Bilal Hammoud (MPI): features extension
• Julian Eßer (DFKI): features extension (contact stability)

The development of Crocoddyl is supported by the EU MEMMO project, and the EU RoboCom++ project. It is maintained by the Gepetto team @LAAS-CNRS, the Statistical Machine Learning and Motor Control Group @University of Edinburgh, and the Willow team @INRIA.