Skip to main content

Simple simulation environment for robots, based on the urdf files.

Project description

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.

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

urdfenvs-0.9.14.tar.gz (155.9 kB view details)

Uploaded Source

Built Distribution

urdfenvs-0.9.14-py3-none-any.whl (173.8 kB view details)

Uploaded Python 3

File details

Details for the file urdfenvs-0.9.14.tar.gz.

File metadata

  • Download URL: urdfenvs-0.9.14.tar.gz
  • Upload date:
  • Size: 155.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.13 Linux/5.15.0-1064-azure

File hashes

Hashes for urdfenvs-0.9.14.tar.gz
Algorithm Hash digest
SHA256 6aa3ec7d800f50fde265b7ea34150256e0798ab4d499fe3889c0b4a89bf79403
MD5 5a8588d5ea72896ce1a3b9aea748dac8
BLAKE2b-256 960837197956f8a38a9a96a72f01976e4f9e5fa1fd943db176fb944d5e57604f

See more details on using hashes here.

File details

Details for the file urdfenvs-0.9.14-py3-none-any.whl.

File metadata

  • Download URL: urdfenvs-0.9.14-py3-none-any.whl
  • Upload date:
  • Size: 173.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.13 Linux/5.15.0-1064-azure

File hashes

Hashes for urdfenvs-0.9.14-py3-none-any.whl
Algorithm Hash digest
SHA256 0dbcb7cd699b612109921755a4b61b4ac12e200669d034fcac0c645a27922e2f
MD5 dafe340be026f35c33d9418904c220e3
BLAKE2b-256 b89dbe7f9cde1b797d621e50a975c1d6334279879745f20204dd20e6265b71c2

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