Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2b-t/docker-for-robotics

Collection of best practices for working with Docker/Docker-Compose and the Robot Operating System (ROS/ROS 2) in simulation as well as with hardware and real-time requirements
https://github.com/2b-t/docker-for-robotics

best-practice best-practices docker docker-compose dockerfile graphic-user-interface gui guide guidelines network real-time robot robot-operating-system robotics ros ros-noetic ros2 ros2-humble tutorial wsl2

Last synced: about 11 hours ago
JSON representation

Collection of best practices for working with Docker/Docker-Compose and the Robot Operating System (ROS/ROS 2) in simulation as well as with hardware and real-time requirements

Host: GitHub
URL: https://github.com/2b-t/docker-for-robotics
Owner: 2b-t
License: mit
Created: 2023-02-05T11:31:22.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-11-07T23:21:02.000Z (2 months ago)
Last Synced: 2025-01-13T23:07:16.525Z (7 days ago)
Topics: best-practice, best-practices, docker, docker-compose, dockerfile, graphic-user-interface, gui, guide, guidelines, network, real-time, robot, robot-operating-system, robotics, ros, ros-noetic, ros2, ros2-humble, tutorial, wsl2
Language: Dockerfile
Homepage:
Size: 4.14 MB
Stars: 245
Watchers: 5
Forks: 18
Open Issues: 0
Metadata Files:
- Readme: ReadMe.md
- License: License.md

Awesome Lists containing this project

README

        # Docker for Robotics with the Robot Operating System (ROS/ROS 2)

Author: [Tobit Flatscher](https://github.com/2b-t) (2021 - 2024)

[![ROS Docker](https://github.com/2b-t/docker-for-robotics/actions/workflows/build-ros.yml/badge.svg)](https://github.com/2b-t/docker-for-robotics/actions/workflows/build-ros.yml) [![ROS 2 Docker](https://github.com/2b-t/docker-for-robotics/actions/workflows/build-ros2.yml/badge.svg?branch=main)](https://github.com/2b-t/docker-for-robotics/actions/workflows/build-ros2.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Overview

This guide discusses best practices for **robotics development with the [Robot Operating System (ROS/ROS 2)](https://www.ros.org/) and Docker/Docker-Compose** on **Linux** as well as **Windows** operating systems. This includes displaying **graphic user interfaces**, working with hardware, **real-time capable code** and the **network set-up** for multiple machines. Additionally it walks you through the **set-up with Visual Studio Code**.

This repository used to be part of [another guide](https://github.com/2b-t/docker-realtime) I have written on Docker and real-time applications. As the general Docker and ROS part has now become quite lengthy, I have decided to extract it and create a repository of its own for it.

| ![Docker on Ubuntu](./media/ubuntu_jammy_affordance_templates.png) | ![Docker on Windows](./media/windows10_affordance_templates.png) |

| ------------------------------------------------------------ | ------------------------------------------------------------ |

| ROS Indigo running from a Docker container on Ubuntu 22.04   | ROS Indigo running from a Docker container on Windows 10 with WSL2 |

## Structure of this guide

This guide is structured in the following chapters:

- [**Motivation**](./doc/Motivation.md): Tries to give you good reasons for why you should use Docker as a company or research institution.

- [**Introduction to Docker and Docker-Compose**](./doc/Introduction.md): Introduces fundamental concepts of container-based development.

- [**Set-up with Visual Studio Code**](./doc/VisualStudioCodeSetup.md): Walks you through the set-up of containers with Visual Studio Code.

- [**Graphic user interfaces and Docker**](./doc/Gui.md): Discusses the challenges of using Docker with graphic user interfaces and presents workarounds.

- [**ROS and Docker**](./doc/Ros.md): Discusses best-practices for Docker and ROS/ROS 2.

- [**Docker on Windows**](./doc/Windows.md): Running Docker on Windows in WSL2 with graphic user interfaces.

- [**Working with hardware**](./doc/WorkingWithHardware.md): Discusses best-practices when working with hardware.

The folder [**`examples/`**](./examples) contains different ROS and ROS 2 examples (in simulation as well as with hardware access) while the folder  [**`templates/`**](./templates) provides templates for ROS and ROS 2 that you can build your own workspace off. This guide is further extended by an external guide on **Docker for real-time applications with `PREEMPT_RT`** that can be found [here](https://github.com/2b-t/docker-realtime).

 

## Get a copy

This workspace contains several other repositories as submodules. Therefore please clone it with the following command:

```bash

$ git clone --recurse-submodules https://github.com/2b-t/docker-for-robotics.git

```