Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
4 of 11 committers (36.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.9%) to scientific vocabulary
Repository
URDF environments for gym
Basic Info
- Host: GitHub
- Owner: maxspahn
- License: gpl-3.0
- Language: Python
- Default Branch: develop
- Homepage: https://maxspahn.github.io/gym_envs_urdf/
- Size: 88.9 MB
Statistics
- Stars: 48
- Watchers: 2
- Forks: 15
- Open Issues: 23
- Releases: 20
Metadata Files
README.md
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
{.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, 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.
{.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/.
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.
Owner
- Name: Max Spahn
- Login: maxspahn
- Kind: user
- Location: Delft, Netherlands
- Company: @tud-amr; @eager-dev
- Website: https://maxspahn.github.io/markdown-cv/
- Twitter: mspahn2
- Repositories: 47
- Profile: https://github.com/maxspahn
"Comments are a manifestation of failure." Ph.D. candidate at TU Delft, Cognitive Robotics, Project AIRLab. Mobile manipulation in dynamic environments.
Citation (CITATION.cff)
cff-version: 1.2.0
title: Urdf-Environment
message: "If you use this software, please cite it as below."
type: software
authors:
- given-names: 'Max '
email: m.spahn@tudelft.nl
family-names: Spahn
orcid: 'https://orcid.org/0000-0002-9829-6991'
affiliation: Creator
license: GPL-3.0
version: 1.0.0
doi: "10.4121/19362017"
url: "https://github.com/maxspahn/gym_envs_urdf"
GitHub Events
Total
- Create event: 8
- Release event: 2
- Issues event: 5
- Watch event: 6
- Delete event: 3
- Issue comment event: 5
- Push event: 13
- Pull request event: 8
- Fork event: 2
Last Year
- Create event: 8
- Release event: 2
- Issues event: 5
- Watch event: 6
- Delete event: 3
- Issue comment event: 5
- Push event: 13
- Pull request event: 8
- Fork event: 2
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 321
- Total Committers: 11
- Avg Commits per committer: 29.182
- Development Distribution Score (DDS): 0.268
Top Committers
| Name | Commits | |
|---|---|---|
| Max | m****n@t****l | 235 |
| Ziang Qiu | z****u@g****m | 19 |
| Skylove Qiu | z****u@s****l | 18 |
| Chadi Salmi | c****i@t****l | 14 |
| Gijs Groote | g****e@h****m | 13 |
| Gijs Groote | g****e@s****l | 8 |
| edmundwsy | e****y@o****m | 4 |
| Caspar van Venrooij | c****2@g****m | 3 |
| maxspahn | m****3@y****e | 3 |
| Continuous Integration | n****y@g****m | 3 |
| Alexander | 3****z@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 53
- Total pull requests: 140
- Average time to close issues: 4 months
- Average time to close pull requests: 4 days
- Total issue authors: 17
- Total pull request authors: 8
- Average comments per issue: 3.17
- Average comments per pull request: 0.98
- Merged pull requests: 129
- Bot issues: 0
- Bot pull requests: 1
Past Year
- Issues: 2
- Pull requests: 5
- Average time to close issues: 1 day
- Average time to close pull requests: 1 day
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- maxspahn (24)
- behradkhadem (9)
- GijsGroote (2)
- rensheemskerk (2)
- yj-Tang (2)
- DasWilheim (2)
- Capsar (2)
- harmfrima (1)
- josyulakrishna (1)
- alexoelkers (1)
- c-salmi (1)
- Quirina300 (1)
- saraybakker1 (1)
- SkyloveQiu (1)
- bakuljangley (1)
Pull Request Authors
- maxspahn (140)
- LuziaKn (4)
- behradkhadem (4)
- casparvv (2)
- GijsGroote (1)
- lgtm-com[bot] (1)
- saraybakker1 (1)
- c-salmi (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 279 last-month
- Total dependent packages: 2
- Total dependent repositories: 4
- Total versions: 29
- Total maintainers: 2
pypi.org: urdfenvs
Simple simulation environment for robots, based on the urdf files.
- Homepage: https://maxspahn.github.io/gym_envs_urdf/
- Documentation: https://maxspahn.github.io/gym_envs_urdf/
- License: GPL-3.0-or-later
-
Latest release: 0.10.2
published about 1 year ago
Rankings
Dependencies
- autopep8 1.6.0 develop
- pycodestyle 2.8.0 develop
- alabaster 0.7.12
- atomicwrites 1.4.1
- attrs 21.4.0
- babel 2.10.3
- casadi 3.5.6.pre2
- certifi 2022.6.15
- charset-normalizer 2.0.12
- cloudpickle 2.1.0
- colorama 0.4.5
- decorator 5.1.1
- dill 0.3.4
- docutils 0.17.1
- evdev 1.6.0
- freetype-py 2.2.0
- geomdl 5.3.1
- gym 0.21.0
- idna 3.3
- imageio 2.15.0
- imagesize 1.4.1
- importlib-metadata 4.8.3
- iniconfig 1.1.1
- jinja2 3.0.3
- lxml 4.9.1
- markupsafe 2.0.1
- motion-planning-scenes 0.1.19
- multiprocess 0.70.12.2
- networkx 2.2
- numpy 1.19.5
- packaging 21.3
- pillow 8.4.0
- pluggy 1.0.0
- pockets 0.9.1
- py 1.11.0
- pybullet 3.2.5
- pycollada 0.6
- pyglet 1.5.26
- pygments 2.12.0
- pynput 1.7.6
- pyobjc-core 8.5
- pyobjc-framework-applicationservices 8.5
- pyobjc-framework-cocoa 8.5
- pyobjc-framework-quartz 8.5
- pyopengl 3.1.0
- pyparsing 3.0.7
- pyquaternion 0.9.9
- pyrender 0.1.45
- pytest 6.2.5
- python-dateutil 2.8.2
- python-xlib 0.31
- pytz 2022.1
- pyyaml 6.0
- requests 2.27.1
- scipy 1.5.4
- six 1.16.0
- snowballstemmer 2.2.0
- sphinx 4.2.0
- sphinx-rtd-theme 1.0.0
- sphinxcontrib-applehelp 1.0.2
- sphinxcontrib-devhelp 1.0.2
- sphinxcontrib-htmlhelp 2.0.0
- sphinxcontrib-jsmath 1.0.1
- sphinxcontrib-napoleon 0.7
- sphinxcontrib-qthelp 1.0.3
- sphinxcontrib-serializinghtml 1.1.5
- toml 0.10.2
- trimesh 3.12.9
- typing-extensions 4.1.1
- urdfpy 0.0.22
- urllib3 1.26.11
- zipp 3.6.0
- autopep8 ^1.6.0 develop
- Sphinx 4.2.0
- gym ^0.21.0
- motion-planning-scenes ^0.1.19
- multiprocess ^0.70.12
- numpy ^1.19.0
- pybullet ^3.2.1
- pynput ^1.7.6
- pytest ^6.2.5
- python ^3.6, <3.11
- sphinx-rtd-theme 1.0.0
- sphinxcontrib-napoleon 0.7
- urdfpy ^0.0.22
- JamesIves/github-pages-deploy-action 4.1.4 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- snok/install-poetry v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- snok/install-poetry v1 composite
- JRubics/poetry-publish v1.13 composite
- actions/checkout v3 composite
- actions/setup-python v2 composite
- ncipollo/release-action v1 composite
- orhun/git-cliff-action v2 composite
- snok/install-poetry v1 composite