Skip to main content

Quick Start

This quick start sets up an Ubuntu development machine, clones the TurtleBot3 platform, and opens a multi-terminal session on it.

note

The whole OpenRoSDE is containerized with Docker. This ensures that all the contributors work in the exact same software environment.

💻 Supported Software Platforms​

PlatformGPU AccelerationNotes
Ubuntu 24.04 LTS (native)Nvidia GPU via Nvidia Container ToolkitRecommended setup
Ubuntu 24.04 LTS on Windows 11 via WSL 2WSLg D3D12 Mesa driverLower 3D performance than native

🚀 Steps​

  1. Clone and set up:

    sudo apt-get update && sudo apt-get install -y git
    git clone https://github.com/openrosde/openrosde.git && cd openrosde/
    bash ./SETUP-DEVEL-MACHINE.bash
    sudo reboot

  2. Clone a robot platform into extensions/, then switch to it (the default .env selects turtlebot3):

    git clone https://github.com/openrosde/openrosde-platform-turtlebot3.git extensions/openrosde-platform-turtlebot3
    bash ./SWITCH-ROBOT-PLATFORM.bash turtlebot3

  3. Build the Docker image:

    bash ./BUILD-DOCKER-IMAGE.bash

  4. Run the Docker container:

    bash ./RUN-DOCKER-CONTAINER.bash

  5. Inside the container, initialize the environment:

    openrosde-initialize-new-container

  6. Exit the container (Ctrl+d) and launch the multi-terminal session from the Ubuntu development machine:

    bash ./RUN-TMUX-SESSION.bash

    The session opens its tabs in the same standard order on every platform, robot, extra, tools, user, and host, and leaves out a tab with no pane. Its first pane shows how to use its tabs and panes, which openrosde-help prints again in any shell of the container. The Terminator layout of earlier releases still opens with bash ./RUN-TERMINATOR-TERMINAL.bash, until #3 removes it.

note

The core holds no TurtleBot3, since each canonical platform lives in a repository of its own, as Platforms & Devices lists. The entry scripts stop with the commands that clone the platform when .env or .env.custom selects a platform cloned nowhere.

🧭 Next Steps​