Skip to content

README.md

Latest commit

 

History

History
63 lines (41 loc) · 1.47 KB

README.md

File metadata and controls

63 lines (41 loc) · 1.47 KB

Algorithmic Robots World

This repo provides multiple containers to work with,

  • Turtlebot4 Physical robots
  • Simulation environment depicting a Mars surface
  • Jupyter Notebook exploring basic concepts

More information on Containers and Usage

Install Docker

Follow the official instructions here

Clone the repo

On the terminal run the following command to clone the repo

git clone https://github.com/CollaborativeRoboticsLab/algorithmic-robots-world.git

Configure the parameters

Required environmental variables need to be in a .env file. An example.env file is available. Rename that file to .env and update the values as required.

More information on Parameters

Doing custom work

Use the provided web based code server to develop your work.

More information on Code Server

Quick commands

Start Simulation environment

cd algorithmic-robots-world
docker compose -f compose-simulation.yaml pull
xhost +local:root
docker compose -f compose-simulation.yaml up

Start Physical robot environment

cd algorithmic-robots-world
docker compose -f compose-physical.yaml pull
xhost +local:root
docker compose -f compose-physical.yaml up

Start Algorithmic Robotics Labs

cd algorithmic-robots-world
docker compose -f compose-jupyter.yaml pull
xhost +local:root
docker compose -f compose-jupyter.yaml up