Skip to content

Installation.md

Latest commit

 

History

History
208 lines (148 loc) · 6.32 KB

Installation.md

File metadata and controls

208 lines (148 loc) · 6.32 KB
Raw

For new users

Before installing the framework, you should make yourself familiar with ROS and how it works. A good starting point is the official ROS tutorials.

Prerequisites

The CRS environment uses Docker to allow cross-platform compatibility. The only requirement you have is to run an up-to-date operating system and up to 16 GB of free storage (some of it is only required during the setup). Below you find the install instructions for Ubuntu, macOS and Windows. For other operating systems, please contact the principal developers.

Install Instructions

Ubuntu (recommended) These instructions were tested on the following Ubuntu versions:
  • 18.04 LTS
  • 20.04 LTS

However, the instructions should apply to all recent Ubuntu versions.

Steps

  1. Install Docker using the offical install instructions   Note: The install instructions list Ubuntu in the server section!

  2. Allow Docker execution as a non-root user; follow these instructions   Note: Only do the first section "Manage Docker as a non-root user"

  3. Test your Docker installation with the following command   Note: You might want to restart your computer at this point.

    docker run hello-world

  4. Clone the git repository   Note: to clone over SSH instead, make sure you have an SSH key set up.

    git clone --recursive https://github.com/IntelligentControlSystems/crs.git

  5. Navigate to the Ubuntu setup folder

    cd crs-2.0/.setup/ubuntu

  6. Execute the setup script

    ./setup.sh
MacOS

These instructions were tested on macOS Sonoma (14.4). However, the instructions should apply to all recent macOS versions.

Steps

  1. Install Docker using the offical install instructions

  2. Test your Docker installation with the following command

    docker run hello-world

  3. Clone the git repository   Note: Make sure you have a SSH key set up, otherwise this doesn't work.

    git clone --recursive https://github.com/IntelligentControlSystems/crs.git

  4. Navigate to the MacOS setup folder

    cd crs-2.0/.setup/macos

  5. Execute the setup script

    ./setup.sh
Windows These instructions were tested on the following Windows versions:
  • Windows 11

Windows 10 should work as well, but might need some slight modifications.

Steps

  1. Install Docker using the official install instructions

  2. Make sure to run Docker on WSL 2 (see Docker Desktop WSL 2 backend on Windows)

    1. Make sure you have WSL 2 installed and set Ubuntu as the default distro.

    2. Make sure to tick the boxes in the Docker Desktop as in the screenshots below.

      image.png{width="840" height="440"}

      Screenshot 2024-08-30 103945.png{width="1440" height="759"}

  3. Open a PowerShell Terminal and get into your default WSL with:

    wsl

  4. Test your Docker installation with the following command   Note: You might want to restart your computer at this point.

    docker run hello-world

  5. Clone the git repository Note: to clone over SSH instead, make sure you have an SSH key set up.

    git clone --recursive https://github.com/IntelligentControlSystems/crs.git

  6. Navigate to the Ubuntu setup folder

    cd crs-2.0/.setup/ubuntu

  7. Execute the setup script

    ./setup.sh
Manual Installation

To install the CRS platform without Docker use the following instructions. This only works with Ubuntu 18.04!

Steps

  1. Install ROS Melodic using these instructions

  2. Clone the git repository   Note: Make sure you have a SSH key set up, otherwise this doesn't work.

    git clone --recursive https://github.com/IntelligentControlSystems/crs.git

  3. Navigate to the parent folder

    cd crs/

  4. Execute the setup script

    ./.crs/setup-crs.sh

Arch Linux

The Installation does not differ too much from the Ubuntu installation. There is however one caveat on Arch Linux: Running Docker containers might fill up your memory and crash your system. To prevent this, add following lines to the file /etc/docker/daemon.json :

{
  "default-ulimits": {
    "nofile": {
      "Name": "nofile",
      "Soft": 1024,
      "Hard": 524288
    }
  }
}

Do not forget to restart the docker service with sudo systemctl restart docker.

Alternatively, one can specify these limits in the docker-compose.yaml file:

version: '3'
name: "crs"
services:
  crs:

    ...

    # ADD THESE 4 LINES
    ulimits:
      nofile:
        soft: 1024
        hard: 524288

    ...

Next

  1. After the setup script has finished, you should log out of your terminal and open a new one. This step ensures the terminal environment is reloaded with all the changes.

  2. In the crs folder, get familiar with the crs-docker tool by running

    crs-docker --help

  3. Initialize the CRS Docker environment with

    crs-docker up

Note: The first time, the last command might take a while to execute. Additionally, make sure you are not connected to a mobile network, since the first execution of the command above will download large amounts of data.

Sources: