wkentaro / pybullet_planning

A suite of utility functions to facilitate robotic planning related research on the pybullet physics simulation engine.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pybullet_planning

Documentation Status Travis CI Coveralls License MIT

pybullet_planning is a suite of utility functions to facilitate robotic planning related research on the pybullet physics simulation engine. Planning research made easy.

Main features

  • easy-to-use functions to connect with pybullet, tailored for task and motion planning research
  • built-in implementations of standard motion planners, including PRM, RRT, biRRT, A* etc.

Getting Started

pybullet_planning can be installed using pip:

pip install pybullet_planning

Note

On Windows, you may need to install Microsoft Visual C++ 14.0.

Once the installation is completed, you can verify your setup. Start Python from the command prompt and run the following:

>>> import pybullet_planning

First Steps

Contributing

We love contributions!

Check the Contributor's Guide for more details.

Releasing this project

Ready to release a new version of pybullet_planning? Here's how to do it:

  • We use semver, i.e. we bump versions as follows:
    • patch: bugfixes.
    • minor: backwards-compatible features added.
    • major: backwards-incompatible changes.
  • Update the CHANGELOG.rst with all novelty!
  • Ready? Release everything in one command:
invoke release [patch|minor|major]
# with -b to bump version
  • Celebrate! 💃

PyBullet Resources

Credits

Caelan Reed Garrett. PyBullet Planning. https://pypi.org/project/pybullet-planning/. 2020.

This package was initiated and maintained by Caelan Garrett @caelan and other contributors.

About

A suite of utility functions to facilitate robotic planning related research on the pybullet physics simulation engine.

License:MIT License


Languages

Language:Python 100.0%