Skip to main content

Generic URDF robots

In this package, generic urdf robots and a panda gym environment are available. The goal is to make this environment as easy as possible to deploy. Although, we used the OpenAI-Gym framing, these environments are not necessarly restricted to Reinforcement-Learning but rather to local motion planning in general.

Pybullet

Point Robot Point Robot with Keyboard Input Non-Holonomic Robot
Tiago Robot Tiago Robot with Keyboard Input
Panda Robot Albert Robot

Mujoco

Point Robot Panda Robot

Getting started

This is the guide to quickle get going with urdf gym environments.

Pre-requisites

  • Python >=3.8
  • pip3
  • git

Installation from pypi

The package is uploaded to pypi so you can install it using

pip3 install urdfenvs

Installation from source

You first have to download the repository

git clone git@github.com:maxspahn/gym_envs_urdf.git

Then, you can install the package using pip as:

pip3 install .

The code can be installed in editible mode using

pip3 install -e .

Note that we recommend using poetry in this case.

Optional: Installation with poetry

If you want to use poetry, you have to install it first. See their webpage for instructions docs. Once poetry is installed, you can install the virtual environment with the following commands. Note that during the first installation poetry update takes up to 300 secs.

poetry install

The virtual environment is entered by

poetry shell

Inside the virtual environment you can access all the examples.

Installing dependencies

Dependencies should be installed through pip or poetry, see below.

Using pip, you can use

pip3 install '.[options]'

Using poetry

poetry install --with <options>

Options are keyboard.

Examples

You find several python scripts in examples/. You can test those examples using the following (if you use poetry, make sure to enter the virtual environment first with poetry shell)

python3 pointRobot.py

Replace pointRobot.py with the name of the script you want to run.

Metadata

Release files for urdfenvs 0.10.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for urdfenvs 0.10.2
File Size Uploaded Provenance Actions
urdfenvs-0.10.2.tar.gz 155.0 kB Without provenance Details for urdfenvs-0.10.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for urdfenvs 0.10.2
File Interpreter ABI Platform Actions
urdfenvs-0.10.2-py3-none-any.whl Python 3 none any Details for urdfenvs-0.10.2-py3-none-any.whl

Total release size: 332.9 kB

Release files / urdfenvs-0.10.2.tar.gz

Download URL urdfenvs-0.10.2.tar.gz
Size 155.0 kB
Tags Source
SHA-256 checksum
How to use checksums
67653e7691ae36373e8da8d3969a60072c95c9208e062ad71c3665fc0cb5b347
BLAKE2b-256 checksum
How to use checksums
d657d3984c26435fcc61f4b93b5884be5f0c2f9dbdfc42668a90a65d98b81aa0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.7 Linux/5.15.0-1078-azure

Release files / urdfenvs-0.10.2-py3-none-any.whl

Download URL urdfenvs-0.10.2-py3-none-any.whl
Size 177.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f033fb08d2337099e415a258340c480e1e029d7267130ca84c1cb4e64365c7e6
BLAKE2b-256 checksum
How to use checksums
727f30e33ddb8887c03985369f5d1c8779af9c9888f1cccc4004fc933d42e9d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.0.1 CPython/3.10.7 Linux/5.15.0-1078-azure

Security for urdfenvs 0.10.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page