Skip to content

README.md

Latest commit

 

History

History
42 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.46 KB

Algorithmic Robots Lab Notebooks

Open In Colab Open in Visual Studio Code

Prerequisites

The notebooks are designed to be standalone and to study mathematical concepts of robotics as explained in the sections below.

Dependencies

Update the requirements.txt with any Python packages required

Docker

A Dockerfile is provided to run the notebooks in a container. To build the container locally, run the following command in a terminal at the top level of this git repository.

# build the Docker container
docker build -t arlab .

# run the Docker container
docker run -p 8888:8888 arlab start-notebook.sh --NotebookApp.token='' --ip=0.0.0.0 --port=8888

Or use the docker compose file to pull the latest container from ghcr.io

docker compose pull
docker compose up

Devcontainer for live development

Open the project with VSCode and install the DevContainer plugin. This will mount the development environment.

To test the notebooks, run the following command from within the devcontainer.

start-notebook.sh --NotebookApp.token=''

This also allows for live modifications from the browser interface itself. Make sure to sync changes to GitHub at the end.