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.
<table>
<tr>
<td> Point Robot </td>
<td> Point Robot with Keyboard Input </td>
<td> Non-Holonomic Robot </td>
</tr>
<tr>
<td> <img src="/docs/source/img/pointRobot.gif" width="250" height="250"/> </td>
<td> <img src="/docs/source/img/pointRobotKeyboardInput.gif" width="250" height="250"/> </td>
<td> <img src="/docs/source/img/boxerRobot.gif" width="250" height="250"/> </td>
</tr>
</table>
<table>
<tr>
<td> Tiago Robot </td>
<td> Tiago Robot with Keyboard Input </td>
</tr>
<tr>
<td> <img src="/docs/source/img/tiago.gif" width="250" height="250"/> </td>
<td> <img src="/docs/source/img/tiagoKeyboardInput.gif" width="250" height="250"/> </td>
</tr>
</table>
<table>
<tr>
<td> Panda Robot </td>
<td> Albert Robot </td>
</tr>
<tr>
<td> <img src="/docs/source/img/panda.gif" width="250" height="250"/> </td>
<td> <img src="/docs/source/img/albert.gif" width="250" height="250"/> </td>
</tr>
</table>
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
``` {.sourceCode .bash}
pip3 install urdfenvs
```
Installation from source
------------------------
You first have to download the repository
``` {.sourceCode .bash}
git clone git@github.com:maxspahn/gym_envs_urdf.git
```
Then, you can install the package using pip as:
``` {.sourceCode .bash}
pip3 install .
```
The code can be installed in editible mode using
``` {.sourceCode .bash}
pip3 install -e .
```
Note that we recommend using poetry in this case.
Optional: Installation with poetry
----------------------------------
If you want to use [poetry](https://python-poetry.org/docs/), you have
to install it first. See their webpage for instructions
[docs](https://python-poetry.org/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.
``` {.sourceCode .bash}
poetry install
```
The virtual environment is entered by
``` {.sourceCode .bash}
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
``` {.sourceCode .bash}
pip3 install '.[options]'
```
Using poetry
``` {.sourceCode .bash}
poetry install --with <options>
```
Options are `keyboard`.
Examples
--------
You find several python scripts in
[examples/](https://github.com/maxspahn/gym_envs_urdf/tree/master/examples).
You can test those examples using the following (if you use poetry, make
sure to enter the virtual environment first with `poetry shell`)
``` {.sourceCode .python}
python3 pointRobot.py
```
Replace pointRobot.py with the name of the script you want to run.
Raw data
{
"_id": null,
"home_page": "https://maxspahn.github.io/gym_envs_urdf/",
"name": "urdfenvs",
"maintainer": "Max Spahn",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "m.spahn@tudelft.nl",
"keywords": "robotics,motion-planning,simulation",
"author": "Max Spahn",
"author_email": "m.spahn@tudelft.nl",
"download_url": "https://files.pythonhosted.org/packages/0c/82/c1f79d8acd0215123fb9dd229986d397641ef513bcc3a0db246d0cf42bb8/urdfenvs-0.8.19.tar.gz",
"platform": null,
"description": "Generic URDF robots\n===================\n\nIn this package, generic urdf robots and a panda gym environment are\navailable. The goal is to make this environment as easy as possible to\ndeploy. Although, we used the OpenAI-Gym framing, these environments are\nnot necessarly restricted to Reinforcement-Learning but rather to local\nmotion planning in general.\n\n\n<table>\n <tr>\n <td> Point Robot </td>\n <td> Point Robot with Keyboard Input </td>\n <td> Non-Holonomic Robot </td>\n </tr>\n <tr>\n <td> <img src=\"/docs/source/img/pointRobot.gif\" width=\"250\" height=\"250\"/> </td>\n <td> <img src=\"/docs/source/img/pointRobotKeyboardInput.gif\" width=\"250\" height=\"250\"/> </td> \n <td> <img src=\"/docs/source/img/boxerRobot.gif\" width=\"250\" height=\"250\"/> </td>\n </tr>\n</table>\n\n<table>\n <tr>\n <td> Tiago Robot </td>\n <td> Tiago Robot with Keyboard Input </td>\n </tr>\n <tr>\n <td> <img src=\"/docs/source/img/tiago.gif\" width=\"250\" height=\"250\"/> </td>\n <td> <img src=\"/docs/source/img/tiagoKeyboardInput.gif\" width=\"250\" height=\"250\"/> </td>\n </tr>\n</table>\n\n<table>\n <tr>\n <td> Panda Robot </td>\n <td> Albert Robot </td>\n </tr>\n <tr>\n <td> <img src=\"/docs/source/img/panda.gif\" width=\"250\" height=\"250\"/> </td>\n <td> <img src=\"/docs/source/img/albert.gif\" width=\"250\" height=\"250\"/> </td>\n </tr>\n</table>\n\nGetting started\n===============\n\nThis is the guide to quickle get going with urdf gym environments.\n\nPre-requisites\n--------------\n\n- Python \\>=3.8\n- pip3\n- git\n\nInstallation from pypi\n----------------------\n\nThe package is uploaded to pypi so you can install it using\n\n``` {.sourceCode .bash}\npip3 install urdfenvs\n```\n\nInstallation from source\n------------------------\n\nYou first have to download the repository\n\n``` {.sourceCode .bash}\ngit clone git@github.com:maxspahn/gym_envs_urdf.git\n```\n\nThen, you can install the package using pip as:\n\n``` {.sourceCode .bash}\npip3 install .\n```\n\nThe code can be installed in editible mode using\n\n``` {.sourceCode .bash}\npip3 install -e .\n```\n\nNote that we recommend using poetry in this case.\n\nOptional: Installation with poetry\n----------------------------------\n\nIf you want to use [poetry](https://python-poetry.org/docs/), you have\nto install it first. See their webpage for instructions\n[docs](https://python-poetry.org/docs/). Once poetry is installed, you\ncan install the virtual environment with the following commands. Note\nthat during the first installation `poetry update` takes up to 300 secs.\n\n``` {.sourceCode .bash}\npoetry install\n```\n\nThe virtual environment is entered by\n\n``` {.sourceCode .bash}\npoetry shell\n```\n\nInside the virtual environment you can access all the examples.\n\nInstalling dependencies\n-----------------------\n\nDependencies should be installed through pip or poetry, see below.\n\nUsing pip, you can use\n\n``` {.sourceCode .bash}\npip3 install '.[options]'\n```\n\nUsing poetry\n\n``` {.sourceCode .bash}\npoetry install --with <options>\n```\n\nOptions are `keyboard`.\n\nExamples\n--------\n\nYou find several python scripts in\n[examples/](https://github.com/maxspahn/gym_envs_urdf/tree/master/examples).\nYou can test those examples using the following (if you use poetry, make\nsure to enter the virtual environment first with `poetry shell`)\n\n``` {.sourceCode .python}\npython3 pointRobot.py\n```\n\nReplace pointRobot.py with the name of the script you want to run.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Simple simulation environment for robots, based on the urdf files.",
"version": "0.8.19",
"project_urls": {
"Documentation": "https://maxspahn.github.io/gym_envs_urdf/",
"Homepage": "https://maxspahn.github.io/gym_envs_urdf/",
"Repository": "https://github.com/maxspahn/gym_envs_urdf"
},
"split_keywords": [
"robotics",
"motion-planning",
"simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9a1320c5799109e2c8deb3ff74bc2019ff046da6571a0502068ba53d3a9c80a",
"md5": "457e0793d7b9fd6814fdf6e7d023dd56",
"sha256": "0a643991d9630e2c1cf7aaca7e760c7b7d30b4bc4272c2962f9f328910410429"
},
"downloads": -1,
"filename": "urdfenvs-0.8.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "457e0793d7b9fd6814fdf6e7d023dd56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 21330711,
"upload_time": "2024-01-01T01:09:33",
"upload_time_iso_8601": "2024-01-01T01:09:33.572894Z",
"url": "https://files.pythonhosted.org/packages/d9/a1/320c5799109e2c8deb3ff74bc2019ff046da6571a0502068ba53d3a9c80a/urdfenvs-0.8.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c82c1f79d8acd0215123fb9dd229986d397641ef513bcc3a0db246d0cf42bb8",
"md5": "74615fa1387aec9d6d1f9c5c019e1776",
"sha256": "3d1a39d4338f605cdf4159c13d53dd8127fa385326474e8e0baa809078e21554"
},
"downloads": -1,
"filename": "urdfenvs-0.8.19.tar.gz",
"has_sig": false,
"md5_digest": "74615fa1387aec9d6d1f9c5c019e1776",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 21187778,
"upload_time": "2024-01-01T01:09:37",
"upload_time_iso_8601": "2024-01-01T01:09:37.910671Z",
"url": "https://files.pythonhosted.org/packages/0c/82/c1f79d8acd0215123fb9dd229986d397641ef513bcc3a0db246d0cf42bb8/urdfenvs-0.8.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 01:09:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxspahn",
"github_project": "gym_envs_urdf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "urdfenvs"
}
JSON
