Import open source robot description as Python modules.
Project description
Robot descriptions in Python
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 | Maker | Format | Submodule |
---|---|---|---|
A1 | UNITREE Robotics | MJCF, URDF | a1_description |
Aliengo | UNITREE Robotics | MJCF, URDF | aliengo_description |
Allegro Hand | Wonik Robotics | URDF | allegro_hand_description |
ANYmal B | ANYbotics | MJCF | anymal_b_mj_description |
ANYmal B | ANYbotics | URDF | anymal_b_description |
ANYmal C | ANYbotics | MJCF | anymal_c_mj_description |
ANYmal C | ANYbotics | URDF | anymal_c_description |
Atlas DRC (v3) | Boston Dynamics | URDF | atlas_drc_description |
Atlas v4 | Boston Dynamics | URDF | atlas_v4_description |
Baxter | Rethink Robotics | URDF | baxter_description |
Bolt | ODRI | URDF | bolt_description |
Cassie | Agility Robotics | MJCF | cassie_mj_description |
Cassie | Agility Robotics | URDF | cassie_description |
Crazyflie 2.0 | Bitcraze | URDF | cf2_description |
Double Pendulum | N/A | URDF | double_pendulum_description |
e.DO | Comau | URDF | edo_description |
Fetch | Fetch Robotics | URDF | fetch_description |
FingerEdu | N/A | URDF | finger_edu_description |
Gen2 | Kinova | URDF | gen2_description |
Ginger | Paaila Technology | URDF | ginger_description |
Go1 | UNITREE Robotics | MJCF, URDF | go1_description |
HyQ | IIT | URDF | hyq_description |
iCub | IIT | URDF | icub_description |
iiwa | KUKA | URDF | iiwa_description |
JVRC-1 | AIST | URDF | jvrc_description |
JVRC-1 | AIST | MJCF | jvrc_mj_description |
Laikago | UNITREE Robotics | MJCF, URDF | laikago_description |
Mini Cheetah | MIT | URDF | mini_cheetah_description |
Minitaur | Ghost Robotics | URDF | minitaur_description |
Panda | Franka Emika | URDF | panda_description |
Panda | Franka Emika | MJCF | panda_mj_description |
Pepper | SoftBank Robotics | URDF | pepper_description |
PR2 | Willow Garage | URDF | pr2_description |
Reachy | Pollen Robotics | URDF | reachy_description |
Romeo | Aldebaran Robotics | URDF | romeo_description |
Simple Humanoid | N/A | URDF | simple_humanoid_description |
Robotiq 2F-85 | Robotiq | URDF | robotiq_2f85_description |
Robotiq 2F-85 | Robotiq | MJCF | robotiq_2f85_mj_description |
Shadow Hand | The Shadow Robot Company | MJCF | shadow_hand_mj_description |
Solo | ODRI | URDF | solo_description |
TALOS | PAL Robotics | URDF | talos_description |
TIAGo | PAL Robotics | URDF | tiago_description |
Upkie | Tast's Robots | URDF | upkie_description |
UR10 | Universal Robots | URDF | ur10_description |
UR3 | Universal Robots | URDF | ur3_description |
UR5 | Universal Robots | URDF | ur5_description |
UR5e | Universal Robots | MJCF | ur5e_mj_description |
YuMi | ABB | URDF | yumi_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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file robot_descriptions-0.3.0.tar.gz
.
File metadata
- Download URL: robot_descriptions-0.3.0.tar.gz
- Upload date:
- Size: 23.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.22.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaffff57230bee0af6f1ea7e08eaf3e6a30a7032ac67b4437c92d00b0cb332cd |
|
MD5 | 2a8c178a50a26dbb19ac6a60daeb3aa8 |
|
BLAKE2b-256 | 7a21d0cb35cd787bb84e7d4da59a9e2010711ce072533b71d1dfa7d368a92d46 |
File details
Details for the file robot_descriptions-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: robot_descriptions-0.3.0-py3-none-any.whl
- Upload date:
- Size: 53.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.22.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 842985c47852ff52c5cf6cb421dea754fb40bb6f76b7ad8fc3d423365cdbaad9 |
|
MD5 | 97684290709d8a443055443861f42f92 |
|
BLAKE2b-256 | cbcf68869be955bf502200271ab9937a774dc6c0380873a2b07405bd167021d4 |