A suite of utility functions to facilitate robotic planning related research on the pybullet physics simulation engine.
.. start-badges
.. image:: https://readthedocs.org/projects/pybullet-planning/badge/?version=latest :target: https://pybullet-planning.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://github.com/yijiangh/pybullet_planning/workflows/integration/badge.svg :target: https://github.com/yijiangh/pybullet_planning/actions :alt: Github Actions Integration Status
.. image:: https://coveralls.io/repos/github/yijiangh/pybullet_planning/badge.svg?branch=dev :target: https://coveralls.io/github/yijiangh/pybullet_planning?branch=dev :alt: Coveralls
.. image:: https://img.shields.io/badge/License-MIT-blue.svg :target: https://github.com/yijiangh/pybullet_planning/blob/dev/LICENSE :alt: License MIT
.. image:: https://img.shields.io/badge/pybullet->=3.1.7-ff69b4 :target: https://github.com/bulletphysics/bullet3 :alt: pybullet version
.. end-badges
.. Write project description
pybullet_planning is a suite of utility functions to facilitate robotic planning related research on
the pybullet <https://github.com/bulletphysics/bullet3>
_ physics simulation engine.
Planning research made easy.
pybullet_planning can be installed using pip
:
::
pip install pybullet_planning
.. note::
On Windows, you may need to install `Microsoft Visual C++ 14.0 <https://www.scivision.co/python-windows-visual-c++-14-required/>`_, if pybullet installation fails.
Once the installation is completed, you can verify your setup. Start Python from the command prompt and run the following:
::
>>> import pybullet_planning as pp
Documentation <https://pybullet-planning.readthedocs.io>
_Examples can be found at the unit tests <https://github.com/yijiangh/pybullet_planning/tree/dev/tests>
_.
You will be need to install pytest
to run these tests (pip install pytest
).
Then, individual tests can be run by using their pytest markers <https://docs.pytest.org/en/stable/example/markers.html>
_ by:
::
pytest -s -m collision_fn --viewer
pytest -s -m motion_planning_2D --viewer
Additional pytest-free examples can be found at pybullet_planning_tutorials <https://github.com/yijiangh/pybullet_planning_tutorials>
_.
Check the Contributor's Guide <./CONTRIBUTING.rst>
_ for more details.
pybullet-planning
, motion-planners
.Caelan Reed Garrett. PyBullet Planning. https://pypi.org/project/pybullet-planning/. 2020.
This package was initiated and maintained by Caelan Garrett @caelan <https://github.com/caelan>
_
and other contributors <https://github.com/yijiangh/pybullet_planning/blob/dev/AUTHORS.rst>
_.
This repo is a stable and documented fork of Caelan's pybullet-planning
_
(previously called ss-pybullet
) and motion-planners
_.
New features will continue to be introduced first through these separate repos, and integrated into the current package later.
.. _pybullet-planning: https://github.com/caelan/pybullet-planning .. _motion-planners: https://github.com/caelan/motion-planners