alexandrebarral / uniros

A comprehensive framework for reinforcement learning in robotics, which allows users to train their robots in both simulated and real-world environments.

UniROS: ROS-Based Reinforcement Learning Across Simulated and Real-world Robotics

A comprehensive framework for reinforcement learning in robotics, which allows users to train their robots in both simulated and real-world environments concurrently. It simplifies the process of creating reinforcement learning environments for robots and provides a unified interface for training and evaluating the robots in both simulated and real-world environments.

Overview

This repository, UniROS, is designed to integrate two separate repositories, MultiROS and RealROS, giving users the flexibility to use them either as standalone modules or as integrated parts of UniROS.

Options for Setup

There are two ways to set up this repository:

1. As an Integrated System (with Submodules): Use this option if you do not have MultiROS and RealROS already set up. UniROS will include both as submodules.

2. Using Existing MultiROS and RealROS: Choose this if you already have these repositories cloned and set up independently.

Pre-Setup: Check Existing Repositories

Before proceeding with the setup, determine if you already have multiros and realros on your system. Run the provided check_repos.sh script to automatically check for these repositories:

./check_repos.sh

If the script finds the repositories, follow the instructions for using existing repositories. If not, proceed with the integrated system setup.

1. Setup as an Integrated System

If you do not have MultiROS and RealROS, or you wish to use them as submodules of UniROS, follow these steps:

cd ~/catkin_ws/src
git clone --recurse-submodules https://github.com/ncbdrck/uniros

# Install pip if you haven't already by running this command
sudo apt-get install python3-pip

# install the required Python packages for UniROS by running
cd ~/catkin_ws/src/uniros/uniros/
pip3 install -r requirements.txt

# build the workspace
cd ~/catkin_ws
rosdep install --from-paths src --ignore-src -r -y
catkin build
source devel/setup.bash

Note: MultiROS and RealROS have their own dependencies. Please follow the instructions in their respective repositories to install the dependencies.

2. Setup Using Existing MultiROS and RealROS

If you have existing clones of multiros and realros, follow these instructions:

cd ~/catkin_ws/src
git clone https://github.com/ncbdrck/uniros

# continue with the installation as above

Usage

• Once you have set up UniROS, which includes MultiROS and RealROS, you can use each package to create reinforcement learning environments for your robots.

• You can follow the instructions in the respective repositories to create your own environments. Use the provided examples as a starting point.

• Then, register the created environment with openai gym.

  # gym registration - example
  from gym.envs.registration import register
  
  register(
       id='MyEnv-v0',
       entry_point='multiros.templates.task_envs.MyTaskEnv:MyEnv',
       max_episode_steps=1000,
  )

• Finally instead of using import gym and then gym.make('MyEnv-v0') use the following to create the environment. This will create separate processes for each environment, making it possible to run multiple environments in parallel.

  # for both simulated and real environments
  import uniros as gym
  env = gym.make('MyEnv-v0')

Scripheck_repos.sh`

Below is the check_repos.sh script. Save this in your home directory and run it to check if multiros and realros are already downloaded.

#!/bin/bash

# Function to check if a directory is a Git repository
is_git_repo() {
    if git -C $1 rev-parse 2>/dev/null; then
        return 0
    else
        return 1
    fi
}

# Directories where multiros and realros might exist
MULTIROS_DIR="path/to/multiros"  # ~/catkin_ws/src/multiros
REALROS_DIR="path/to/realros"  # ~/catkin_ws/src/realros
t: `c
# Check multiros
if [ -d "$MULTIROS_DIR" ] && is_git_repo $MULTIROS_DIR; then
    echo "multiros repository found."
else
    echo "multiros repository not found."
fi

# Check realros
if [ -d "$rREALROS_DIR" ] && is_git_repo $REALROS_DIR; then
    echo "realros repository found."
else
    echo "realros repository not found."
fi

Replace path/to/multiros and path/to/realros with the actual paths where you expect these repositories to be. Since we are working with ROS, the path typically should be in the format of ~/ros_workspace_ws/src/.

Cite

If you use UniROS in your research or work and would like to cite it, you can use the following citation:

Articles:

@inproceedings{kapukotuwa_multiros_2022,
	title = {{MultiROS}: {ROS}-{Based} {Robot} {Simulation} {Environment} for {Concurrent} {Deep} {Reinforcement} {Learning}},
	shorttitle = {{MultiROS}},
	doi = {10.1109/CASE49997.2022.9926475},
	booktitle = {2022 {IEEE} 18th {International} {Conference} on {Automation} {Science} and {Engineering} ({CASE})},
	author = {Kapukotuwa, Jayasekara and Lee, Brian and Devine, Declan and Qiao, Yuansong},
	month = aug,
	year = {2022},
	note = {ISSN: 2161-8089},
	pages = {1098--1103},
}

Repository:

@misc{uniros,
  author = {Kapukotuwa, Jayasekara},
  booktitle = {GitHub repository},
  publisher = {GitHub},
  title = {UniROS: ROS-Based Reinforcement Learning Across Simulated and Real-world Robotics},
  url = {https://github.com/ncbdrck/uniros},
  year = {2023}
}

Contact

For questions, suggestions, or collaborations, feel free to reach out to the project maintainer at [email protected].