Preparations and installation

To follow the tutorials, it is strongly suggested to use a virtual environment management, such as Python venv, or more powerfull package managers like uv.

We suggest using uv, as it is very fast and more flexible. If you don’t have it installed, you can find the instructions here.

For running the tutorials, you can move to some path on your machine that is suitable for this:

cd /path/to/tutorials

Using uv

Create a virtual environment and activate it by typing

uv venv
source .venv/bin/activate

Note Technically, with uv, you don’t need to manually activate the venv as long as you are in the same folder. For consistency, and making sure you work in the right venv, we activate it for this tutorial.

Next, you need to install MADAS:

uv pip install madas

Following along in the command line

If you want to follow the tutorials in the command line, after activating your virtual environment, you can run a Python interpreter:

uv run python

and copy the commands from the MADAS website.

Running the notebooks locally

For running the notebooks locally, you first need to install jupyter:

uv pip install jupyter

Then, download the tutorials from https://madas.readthedocs.io/en/latest/tutorials.html and save them at the same path where your virtual environment is.

Run

uv run jupyter notebook

to open jupyter and click on the tutorial that you want to do.

Using Python venv