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.

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. .. code:: bash

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.