Skip to main content

Import open source robot description as Python modules.

Project description

Robot descriptions in Python

Build Coverage PyPI version Status

Import open source robot descriptions as Python modules. The wrapper automatically downloads and cache files at first import. Most Awesome Robot Descriptions are available.

Installation

pip install robot_descriptions

Usage

Import the robot description you are interested in directly as a submodule of robot_descriptions:

from robot_descriptions import my_robot_description

The import will automatically download the robot description if you don't have it already, and cache it to a local directory. The submodule then provides the following paths:

URDF_PATH
Path to the main URDF file of the robot description, if applicable.
MJCF_PATH
Path to the main MJCF file of the robot description, if applicable.
MESHES_PATH
Path to the "meshes" folder of the robot description, if applicable.
PACKAGE_PATH
Path to the root of the robot description.
REPOSITORY_PATH
Path to the working directory of the git repository hosting the robot description.

Some robot descriptions include additional fields. For instance, the iiwa_description exports URDF_PATH_POLYTOPE_COLLISION with more detailed collision meshes.

Examples

Load a robot description:

Visualize a robot description:

Command line tool

The command line tool can be used to visualize any of the robot descriptions below. For example:

robot_descriptions show solo_description

Descriptions

Available robot descriptions (gallery) currently include:

Name Format Maker Submodule
A1 URDF UNITREE Robotics a1_description
Aliengo MJCF UNITREE Robotics aliengo_mj_description
Aliengo URDF UNITREE Robotics aliengo_description
Allegro Hand URDF Wonik Robotics allegro_hand_description
ANYmal B URDF ANYbotics anymal_b_description
ANYmal C URDF ANYbotics anymal_c_description
Atlas URDF Boston Dynamics atlas_description
Baxter URDF Rethink Robotics baxter_description
Bolt URDF ODRI bolt_description
Cassie MJCF Agility Robotics cassie_mj_description
Cassie URDF Agility Robotics cassie_description
Crazyflie 2.0 URDF Bitcraze cf2_description
Double Pendulum URDF N/A double_pendulum_description
e.DO URDF Comau edo_description
FingerEdu URDF N/A finger_edu_description
Gen2 URDF Kinova gen2_description
HyQ URDF IIT hyq_description
iCub URDF IIT icub_description
iiwa URDF KUKA iiwa_description
JVRC-1 MJCF AIST jvrc_mj_description
JVRC-1 URDF AIST jvrc_description
Laikago URDF UNITREE Robotics laikago_description
Mini Cheetah URDF MIT mini_cheetah_description
Minitaur URDF Ghost Robotics minitaur_description
Panda URDF Franka Emika panda_description
PR2 URDF Willow Garage pr2_description
Reachy URDF Pollen Robotics reachy_description
Romeo URDF Aldebaran Robotics romeo_description
Simple Humanoid URDF N/A simple_humanoid_description
Solo URDF ODRI solo_description
TALOS URDF PAL Robotics talos_description
TIAGo URDF PAL Robotics tiago_description
Upkie URDF Tast's Robots upkie_description
UR10 URDF Universal Robots ur10_description
UR3 URDF Universal Robots ur3_description
UR5 URDF Universal Robots ur5_description

New robot descriptions are welcome! Check out the guidelines then open a PR.

Thanks

Thanks to the maintainers of all the git repositories that made these robot descriptions available.

Project details


Download files

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

Source Distribution

robot_descriptions-0.2.0.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

robot_descriptions-0.2.0-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file robot_descriptions-0.2.0.tar.gz.

File metadata

  • Download URL: robot_descriptions-0.2.0.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for robot_descriptions-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d2e8f2226bed4a973b4f961d297bb21c3cffe14b3ba53ee729d3f12f8e916a0a
MD5 3ba7e74fc2febbd3fbe40810bfe11d5f
BLAKE2b-256 543d63654f781a32ba549b7776ee1b551cafa0b07fab441560ec8cc4478be338

See more details on using hashes here.

File details

Details for the file robot_descriptions-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robot_descriptions-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f911c418d48956eb60459d93bd55474e1b02f1baa48611626c840410ae1325c
MD5 b4569ab1ca3bf9025759c6fc58788a2b
BLAKE2b-256 55e313b8ebfa05fdf48df83db3b284c2268318c42909a2dd559c4c178169e412

See more details on using hashes here.

Supported by

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