By Jesse Haviland and Peter Corke

This repository contains a collection of Jupyter Notebooks exploring spatial mathematics and related applications. The notebooks are easily extensible to encourage experimentation.

• Synopsis
• Python Setup Guide
• Running Notebooks Locally
• Running Notebooks on Google Colab
• Acknowledgements

Spatial mathematics is an important and foundational concepts in robotics -- how to represent the position and orientation of things (robots, cameras, widgets) in two or three dimensions. These representations form the foundation of professional practice in robotics and AI. This tutorial also introduces mathematical graphs which, combined with these representations, can be used to describe relative positions of places and objects -- search algorithms applied to such graphs is foundational to most robot navigation tasks.

The Notebooks are written using Python and we use several python packages. We recommend that you set up a virtual environment/Python environment manager. We provide a guide to setting up Conda below but feel free to use any alternative such as virtualenv or venv.

The Notebooks have been tested to run on Ubuntu, Windows and Mac OS with any currently supported version of Python (currently 3.7, 3.8 3.9 and 3.10).

Download miniconda from here while choosing the link for your operating system and architecture.

Follow the Conda install instructions from here.

In the terminal, make a new conda environment. We called our environment smtutorial and recommend choosing Python version 3.10

conda create --name smtutorial python=3.10

We need to activate our environment to use it

conda activate smtutorial

Check out this link for a handy Conda command cheat sheet. There is also a ~30 minute Conda Tutorial available here.

We require several Python packages to run the Notebooks. You should activate the Conda environment before completing this stage.

We use IPython, Jupyter notebook, Robotics Toolbox for Python and associated packages

pip install ipython notebook "roboticstoolbox-python>=1.0.2" sympy

We have tested the Notebooks in the default Jupyter Notebook web interface and the VSCode Notebook extension.

Firstly, you must clone the repository

git clone https://github.com/jhavl/spatialmathematics.git
cd dkt

In terminal, activate the conda environment, navigate to the repository folder and run

conda activate smtutorial
cd "path_to_repo/spatialmathematics"
jupyter-notebook

Download and install VSCode from here.

Add the Python extension, see this link (if not already installed).

Add the Jupyter extension, see this link (if not already installed).

From VSCode, select Open Folder... and navigate to and select the repository folder. You may be prompted to select if you trust the contents of the folder. Warning If you decline to trust the folder, it is unlikely that you will be able to run any of the Notebooks.

After selecting the folder, choose which Notebook you would like to run from the Explorer menu on the left side of the screen.

Once a Notebook is open, you must select the kernel from the Select Kernel button in the top right side of the screen. Choose the conda environment we created earlier smtutorial (Python 3.10.X).

For the fastest and smoothest experience, it is recommended to run the Notebooks locally. However, most Notebooks can be run online on the Google Colab platform.

This tutorial is supported by the Queensland University of Technology Centre for Robotics (QCR).