ROS Gazebo Gym Workspace

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:

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:

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.