ncbdrck / realros

RealROS is an open-source Python framework that seamlessly integrates with ROS (Robot Operating System) to create real-world robotics environments tailored for reinforcement learning (RL) applications. This modular framework simplifies RL development, enabling real-time training with physical robots

RealROS: A Comprehensive Framework for Real-World Robotic Reinforcement Learning

RealROS, is a unified (ROS)-based open-source Python framework to create real-world robotics environments for reinforcement learning (RL) applications.

This framework extends the functionality of ROS by introducing additional Python bindings necessary for automatically launching environments in the real world, eliminating the need for manual configuration of the ROS's low-level features.

This framework provides the following features:

1. A modular architecture that promotes reproducibility and encourages code reuse,
2. Real-time training with any RL simulation framework (Agnostic of any RL simulation framework)
3. Tools to execute concurrent environments and maintain communication.

Prerequisites

Before installing RealROS, make sure you have the following prerequisites:

ROS Installation

RealROS requires a working installation of ROS. If you haven't installed ROS yet, please follow the official ROS installation guide for your specific operating system. This package has been tested with ROS Noetic version, and the following instructions will guide you through the installation of ROS Noetic on Ubuntu 20.04:

sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros-latest.list'
sudo apt install curl
curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | sudo apt-key add -
sudo apt update
sudo apt install ros-noetic-desktop-full

echo "source /opt/ros/noetic/setup.bash" >> ~/.bashrc
source ~/.bashrc

sudo apt install python3-rosdep python3-rosinstall python3-rosinstall-generator python3-wstool build-essential
sudo apt install python3-rosdep
sudo rosdep init
rosdep update

Catkin Tools

RealROS uses Catkin as the build system for ROS packages. Install Catkin Tools by running the following command:

sudo apt-get install python3-catkin-tools

Create ROS Workspace

Before using RealROS, you need to create a ROS workspace to build and run your ROS packages. Follow these steps to create a workspace:

cd ~
source /opt/ros/noetic/setup.bash
mkdir -p ~/catkin_ws/src
cd ~/catkin_ws/
catkin build
echo "source ~/catkin_ws/devel/setup.bash" >> ~/.bashrc
source ~/.bashrc

Other Packages

RealROS also requires the following additional packages:

• XTerm for terminal emulation:

  sudo apt install xterm

• MoveIt for motion planning:

  sudo apt install ros-noetic-moveit

• PyKDL for Kinematics:

  sudo apt install python3-pykdl

• kdl_parser_py for parsing URDF files (for ros_kinematics):

  sudo apt install ros-noetic-kdl-parser-py

• trac_ik_python for inverse kinematics (for Kinematics_pyrobot):

  # Download and install trac_ik_python
  cd ~/catkin_ws/src
  git clone https://bitbucket.org/traclabs/trac_ik.git

• pykdl_utils for kinematics (for Kinematics_pykdl):

  # download the package - modified version of the original package to support ROS Noetic
  cd ~/catkin_ws/src
  git clone https://github.com/ncbdrck/hrl-kdl.git
  
  # install the pykd_utils
  cd ~/catkin_ws/src/hrl-kdl/pykdl_utils
  python3 setup.py build
  sudo python3 setup.py install
  
  # install the hrl_geom
  cd ~/catkin_ws/src/hrl-kdl/hrl_geom
  python3 setup.py build
  sudo python3 setup.py install
  
  # Install urdf_parser and urdfdom-py
  sudo apt-get install ros-noetic-urdf-parser-plugin
  sudo apt-get install ros-noetic-urdfdom-py
  
  # Build the package
  cd ~/catkin_ws
  rosdep install --from-paths src --ignore-src -r -y
  catkin build
  source devel/setup.bash

You are now ready to proceed with the installation and usage of RealROS.

Please note that the instructions assume you are using Ubuntu 20.04 and ROS Noetic. If you are using a different operating system or ROS version, make sure to adapt the commands accordingly.

Installation

To get started with RealROS, follow these steps:

1. Clone the repository:

   cd ~/catkin_ws/src
   git clone -b gymnasium https://github.com/ncbdrck/realros.git

2. RealROS relies on several Python packages. You can install them by running the following command:

   # Install pip if you haven't already by running this command
   sudo apt-get install python3-pip
   
   # install the required Python packages for RealROS by running
   cd ~/catkin_ws/src/realros/
   pip3 install -r requirements.txt

3. Build the ROS packages and source the environment:

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

Usage

You can refer to the templates or the examples to see how to use RealROS to create a real-world environment for RL applications.

It also showcases:

• How to use RealROS to create a real-world environment for RL applications.
• Train the Rx200 robot directly in the real world to perform a simple reach task.
• Use MultiROS framework to create a simulation environment for the same robot and train it in the simulation environment. Then, transfer the learned policy to the real-world environment.
• Train both environments (sim and real) in real-time to obtain a generalized policy that performs well in both environments.

The installation instructions for the examples are provided in the respective repositories.

License

RealROS is released under the MIT License. Please see the LICENSE file for more details.

Acknowledgements

We would like to thank the following projects and communities for their valuable contributions, as well as the authors of relevant libraries and tools used in RealROS.

• ROS (Robot Operating System)
• MoveIt

Cite

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

Repository

@misc{realros,
  author = {Kapukotuwa, Jayasekara},
  booktitle = {GitHub repository},
  publisher = {GitHub},
  title = {RealROS: A Comprehensive Framework for Real-World Robotic Reinforcement Learning},
  url = {https://github.com/ncbdrck/realros},
  year = {2023}
}

Contact

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