gym-ignition

Framework for developing OpenAI Gym robotics environments simulated with Ignition Gazebo

https://github.com/robotology-legacy/gym-ignition

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.7%) to scientific vocabulary

Keywords

gazebo gym gym-ignition ignition ignition-gazebo ignitionrobotics openai openai-gym openai-gym-environment reinforcement-learning robotics scenario simulation
Last synced: 6 months ago · JSON representation

Repository

Framework for developing OpenAI Gym robotics environments simulated with Ignition Gazebo

Basic Info
Statistics
  • Stars: 252
  • Watchers: 28
  • Forks: 27
  • Open Issues: 14
  • Releases: 13
Topics
gazebo gym gym-ignition ignition ignition-gazebo ignitionrobotics openai openai-gym openai-gym-environment reinforcement-learning robotics scenario simulation
Created over 7 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Codeowners

README.md

gym-ignition

CICD Docker Images Codacy Badge

⚠️ Warning ⚠️

This project is no longer actively maintained, and development has stalled. For an in-depth description of the current status and actionable steps to revive development, please consult robotology/gym-ignition#430.

|||| |:---:|:---:|:---:| | | | |

Description

gym-ignition is a framework to create reproducible robotics environments for reinforcement learning research.

It is based on the ScenarIO project which provides the low-level APIs to interface with the Ignition Gazebo simulator. By default, RL environments share a lot of boilerplate code, e.g. for initializing the simulator or structuring the classes to expose the gym.Env interface. Gym-ignition provides the Task and Runtime abstractions that help you focusing on the development of the decision-making logic rather than engineering. It includes randomizers to simplify the implementation of domain randomization of models, physics, and tasks. Gym-ignition also provides powerful dynamics algorithms compatible with both fixed-base and floating-based robots by exploiting robotology/idyntree and exposing high-level functionalities.

Gym-ignition does not provide out-of-the-box environments ready to be used. Rather, its aim is simplifying and streamlining their development. Nonetheless, for illustrative purpose, it includes canonical examples in the gym_ignition_environments package.

Visit the website for more information about the project.

Installation

  1. First, follow the installation instructions of ScenarIO.
  2. pip install gym-ignition, preferably in a virtual environment.

Contributing

You can visit our community forum hosted in GitHub Discussions. Even without coding skills, replying user's questions is a great way of contributing. If you use gym-ignition in your application and want to show it off, visit the Show and tell section! You can advertise there your environments created with gym-ignition.

Pull requests are welcome.

For major changes, please open a discussion first to propose what you would like to change.

Citation

bibtex @INPROCEEDINGS{ferigo2020gymignition, title={Gym-Ignition: Reproducible Robotic Simulations for Reinforcement Learning}, author={D. {Ferigo} and S. {Traversaro} and G. {Metta} and D. {Pucci}}, booktitle={2020 IEEE/SICE International Symposium on System Integration (SII)}, year={2020}, pages={885-890}, doi={10.1109/SII46433.2020.9025951} }

License

LGPL v2.1 or any later version.


Disclaimer: Gym-ignition is an independent project and is not related by any means to OpenAI and Open Robotics.

Owner

  • Name: Robotology Legacy
  • Login: robotology-legacy
  • Kind: organization

GitHub Events

Total
  • Issues event: 26
  • Watch event: 21
  • Issue comment event: 33
  • Pull request event: 4
  • Fork event: 1
Last Year
  • Issues event: 26
  • Watch event: 21
  • Issue comment event: 33
  • Pull request event: 4
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 25
  • Total pull requests: 4
  • Average time to close issues: over 4 years
  • Average time to close pull requests: almost 4 years
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 2.96
  • Average comments per pull request: 8.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • diegoferigo (25)
  • solid-sinusoid (1)
Pull Request Authors
  • diegoferigo (4)
Top Labels
Issue Labels
issue::type::enhancement (9) complexity::hard (7) complexity::low (7) complexity::medium (6) issue::type::reminder (5) component:documentation (5) component::gym_ignition (5) issue::status::in-progress (4) component::scenario::gazebo (4) component::ignition (3) help wanted (3) issue::type::task (3) component::scenario::plugins (2) good first issue (2) issue::status::backlog (2) component::scenario::core (1) component::scenario::python (1) issue::type::bug (1) issue::type::regression (1) priority::low (1) component::gympp (1) issue::type::discussion (1)
Pull Request Labels
pr::status::backlog (2) component::tests (2) component::scenario::gazebo (2) complexity::hard (1) component::bindings (1) component::gym_ignition (1) complexity::medium (1) pr::status::in-progress (1) component::cicd (1) pr::changelog::cicd (1) complexity::low (1) pr::status::feedback (1) pr::changelog::release (1)