Data

Tools

Indexes

Applications

Experiments

Open Source Science

ros-gazebo-gym-ws

A Catkin workspace designed to simplify the setup and use of the ROS Gazebo Gym framework.

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

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 (13.1%) 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

argument-parser mot mesh pypi manifolds interactive dynamics hacking
Last synced: 4 months ago · JSON representation ·

Repository

A Catkin workspace designed to simplify the setup and use of the ROS Gazebo Gym framework.

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

README.md

ROS Gazebo Gym Workspace

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

Welcome to the ROS Gazebo Gym (Catkin) Workspace repository! This repository is designed to simplify the installation and usage of the ros_gazebo_gym framework, providing a convenient workspace for experimenting with various ROS gymnasium task environments.

Repository Overview

The ROS Gazebo Gym Workspace comprises two essential components:

  1. ros_gazebo_gym package: This package encapsulates the entire collection of ROS gymnasium environments provided by the ros_gazebo_gym framework.

  2. ros_gazebo_gym_examples package: Inside this package, you'll discover a set of reinforcement learning (RL) training scripts that make use of the environments available in the ros_gazebo_gym package.

Clone the repository

To use this workspace repository, clone the repository inside a Catkin workspace folder. Since the repository contains several git submodules to use all the features, it needs to be cloned using the --recurse-submodules argument:

bash git clone --recurse-submodules https://github.com/rickstaa/ros-gazebo-gym-ws.git

If you already cloned the repository and forgot the --recurse-submodule argument, you can pull the submodules using the following git command:

bash git submodule update --init --recursive

How to use

For comprehensive instructions on utilizing the ros-gazebo-gym framework and running the provided examples from the ros-gazebo-gym-examples package, refer to the official ros_gazebo_gym documentation.

Contributing

We use husky pre-commit hooks and github actions to enforce high code quality. Please check the contributing guidelines in the ros-gazebo-gym package 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
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 303
  • Total Committers: 4
  • Avg Commits per committer: 75.75
  • Development Distribution Score (DDS): 0.35
Past Year
  • Commits: 92
  • Committers: 3
  • Avg Commits per committer: 30.667
  • Development Distribution Score (DDS): 0.391
Top Committers
Name Email Commits
rickstaa r****a@o****m 197
dependabot[bot] 4****] 56
renovate[bot] 2****] 45
rickstaa r****a 5

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 12
  • Total pull requests: 172
  • Average time to close issues: 12 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.4
  • Merged pull requests: 144
  • Bot issues: 1
  • Bot pull requests: 143
Past Year
  • Issues: 0
  • Pull requests: 65
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.22
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 60
View more stats
Top Authors
Issue Authors
  • rickstaa (11)
  • renovate[bot] (1)
Pull Request Authors
  • dependabot[bot] (108)
  • renovate[bot] (54)
  • rickstaa (30)
Top Labels
Issue Labels
enhancement (2) bug (1)
Pull Request Labels
dependencies (150) javascript (61) submodules (44) bump:patch (44) autorelease: tagged (6) github_actions (3) autorelease: pending (3)

Dependencies

.github/workflows/release_please.yml actions
  • rickstaa/release-please-action optional_pyproject_toml composite
.github/workflows/ros_test.yml actions
  • actions/checkout v2 composite
  • addnab/docker-run-action v3 composite
  • docker/build-push-action v4 composite
  • docker/setup-buildx-action v2 composite
package-lock.json npm
  • 602 dependencies
package.json npm
  • @commitlint/cli 17.7.1 development
  • @commitlint/config-conventional 17.7.0 development
  • commitizen 4.3.0 development
  • cz-conventional-changelog 3.3.0 development
  • husky 8.0.3 development
  • lint-staged 14.0.0 development
  • release-please 15.12.0 development
  • remark 14.0.3 development
  • remark-cli 11.0.0 development
  • remark-lint 9.1.2 development
  • remark-preset-lint-recommended 6.1.3 development
  • sort-package-json 2.5.0 development