ros-gazebo-gym

Framework for integrating ROS and Gazebo with gymnasium, streamlining the development and training of RL algorithms in realistic robot simulations.

https://github.com/rickstaa/ros-gazebo-gym

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
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary

Keywords

framework franka-emika franka-panda gazebo gym gym-environments gymnasium openai-gym panda reinforcement-learning robotics ros simulation

Keywords from Contributors

mesh sequences robust interactive hacking network-simulation
Last synced: 4 months ago · JSON representation ·

Repository

Framework for integrating ROS and Gazebo with gymnasium, streamlining the development and training of RL algorithms in realistic robot simulations.

Basic Info
Statistics
  • Stars: 40
  • Watchers: 2
  • Forks: 3
  • Open Issues: 11
  • Releases: 35
Topics
framework franka-emika franka-panda gazebo gym gym-environments gymnasium openai-gym panda reinforcement-learning robotics ros simulation
Created almost 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Citation Zenodo

README.md

ROS Gazebo Gym

ROS Gazebo Gym ROS Test GitHub release (latest by date) Python 3 ROS version Contributions DOI

The ROS Gazebo Gym framework integrates ROS and Gazebo with gymnasium to facilitate the development and training of RL algorithms in realistic robot simulations. It comes equipped with several ready-to-use simulation environments, allowing for a diverse range of applications and experimentation. This framework provides a streamlined way to apply simulation-trained algorithms to actual robots, thereby enhancing their real-world applicability. Our goal with ROS Gazebo Gym is to establish a robust foundation for RL research in robotics, aiding in the advancement of practical, real-world robot control."

Installation and Usage

Please see the docs for installation and usage instructions.

Contributing

We use husky pre-commit hooks and github actions to enforce high code quality. Please check the CONTRIBUTING.md before contributing to this repository.

[!NOTE]\ We used husky instead of pre-commit, which is more commonly used with Python projects. This was done because only some tools we wanted to use were possible to integrate the Please feel free to open a PR if you want to switch to pre-commit if this is no longer the case.

Owner

  • Name: Rick Staa
  • Login: rickstaa
  • Kind: user
  • Location: Amsterdam
  • Company: Livepeer

Building the future of video AI @livepeer 🚀 | Open-source advocate & tech enthusiast | Robotics & AI researcher | Jazz/blues enthusiast 🎹.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: rickstaa/ros-gazebo-gym
message: >-
  If you want to cite this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Rick
    family-names: Staa
    affiliation: TU Delft
    orcid: 'https://orcid.org/0000-0003-4835-2040'
  - given-names: Wei
    family-names: Pan
    affiliation: The University of Manchester
    orcid: 'https://orcid.org/0000-0003-1121-9879'
identifiers:
  - type: url
    value: 'https://zenodo.org/badge/latestdoi/453634930'
repository-code: 'https://github.com/rickstaa/ros-gazebo-gym'
abstract: >-
  Framework for training reinforcement learning algorithms on a variety of ROS Gazebo environments.
keywords:
  - framework
  - reinforcement-learning
  - simulation
  - openai-gym
  - gym-environments
  - gymnasium
  - gymnasium-environments
  - ros
  - gazebo
  - panda
  - emika-franka
  - reinforcement-learning
  - artificial-intelligence
license: MIT

GitHub Events

Total
  • Watch event: 16
  • Fork event: 1
Last Year
  • Watch event: 16
  • Fork event: 1

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 423
  • Total Committers: 4
  • Avg Commits per committer: 105.75
  • Development Distribution Score (DDS): 0.508
Past Year
  • Commits: 89
  • Committers: 2
  • Avg Commits per committer: 44.5
  • Development Distribution Score (DDS): 0.303
Top Committers
Name Email Commits
RDaneelOlivaw d****t@g****m 208
rickstaa r****a@o****m 178
dependabot[bot] 4****] 27
aezquerro a****o@g****m 10

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 8
  • Total pull requests: 98
  • Average time to close issues: 6 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.15
  • Merged pull requests: 88
  • Bot issues: 0
  • Bot pull requests: 47
Past Year
  • Issues: 4
  • Pull requests: 52
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.75
  • Average comments per pull request: 0.12
  • Merged pull requests: 43
  • Bot issues: 0
  • Bot pull requests: 35
Top Authors
Issue Authors
  • rickstaa (3)
  • YY-GX (2)
  • panweihit (1)
  • chenxing618 (1)
Pull Request Authors
  • dependabot[bot] (63)
  • rickstaa (57)
Top Labels
Issue Labels
bug (4) enhancement (2)
Pull Request Labels
dependencies (62) javascript (53) github_actions (9) autorelease: tagged (8) autorelease: pending (2)

Dependencies

package.json npm
  • @commitlint/cli ^16.1.0 development
  • @commitlint/config-conventional ^16.0.0 development
  • commitizen ^4.2.4 development
  • cz-conventional-changelog 3.3.0 development
  • husky ^7.0.4 development
  • lint-staged ^12.3.3 development
  • remark ^14.0.2 development
  • remark-cli ^10.0.1 development
  • remark-lint ^9.1.1 development
  • remark-preset-lint-recommended ^6.1.2 development
  • sort-package-json ^1.54.0 development
  • standard-version ^9.3.2 development
setup.py pypi
.github/workflows/documentation.yml actions
  • actions/checkout v4 composite
  • addnab/docker-run-action v3 composite
  • docker/build-push-action v5 composite
  • docker/setup-buildx-action v3 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/release_please.yml actions
  • google-github-actions/release-please-action v3 composite
.github/workflows/ros_gazebo_gym.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • reviewdog/action-black v3 composite
  • reviewdog/action-flake8 v3 composite
  • reviewdog/action-remark-lint v5 composite
.github/workflows/ros_test.yml actions
  • actions/checkout v4 composite
  • addnab/docker-run-action v3 composite
  • docker/build-push-action v5 composite
  • docker/setup-buildx-action v3 composite
.github/workflows/test.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • reviewdog/action-alex v1 composite
  • reviewdog/action-black v3 composite
  • reviewdog/action-flake8 v3 composite
  • reviewdog/action-misspell v1 composite
  • reviewdog/action-remark-lint v5 composite
package-lock.json npm
  • 716 dependencies
requirements/dev_requirements.txt pypi
  • black >=23.3.0 development
  • flake8 >=6.0.0 development
  • isort >=5.12.0 development
requirements/doc_requirements.txt pypi
  • myst-parser >=1.0.0
  • sphinx >=7.1.2
  • sphinx-autoapi >=2.1.1
  • sphinx_rtd_theme >=1.3.0
requirements/requirements.txt pypi
  • gymnasium *
  • gymnasium-robotics *
  • numpy *
  • pygit2 *
  • ruamel.yaml *
  • tqdm *