Installation - GRTLCollaboration/engrenage GitHub Wiki

Level Zero: You can use Google Colab to run the Jupyter notebooks and edit your own copy of the code in an internet browser. The avoids the need to download a python installation to your computer. You can either download the zip of the files (as in Level 1) and then drag them into your Colab folder, or get them directly from the GitHub page by providing the url.

Level 1: If you just want to play around with the code and don't expect to save any edits back to the repository, then just press the green "Code" button on the main repository page and download the zip of all the files - this is the simpler option if you are not too familiar with git, but do have a python installation like Anaconda.

Level 2: Use GitHub to fork and clone the repository. Please refer to Useful resources for some tips if you are not familiar with the command line or GitHub.

First fork and clone this repository.
Having obtained a python distribution on your computer (if you are just starting out you may want to use Anaconda), create a Python environment, create a Python environment, e.g. in ./env:
```
python3 -m venv ./env
```

Install the Python requirements:

# Activate the Python environment
. ./env/bin/activate
# Install the requirements (run this in the main repository folder where requirements.txt is located)
pip install -r ./requirements.txt

Run the Jupyter notebook use either:
```
jupyter-lab
```
or
```
jupyter notebook
```
(depending on the style of interface that your prefer)