Skip to content

Tutorials

The tutorials walk through complete SOLWEIG workflows on real city data that ships with the repository. Each page below is the rendered output of a Jupyter notebook, so you can read them here without installing anything.

Running the tutorials yourself

The notebooks live in docs/tutorials/*.ipynb in the repository, and the demo data they use (Athens, Gothenburg, Bilbao) is included in demos/data/, so a clone is all the setup they need:

git clone https://github.com/UMEP-dev/solweig.git
cd solweig
pip install solweig[geo] matplotlib jupyter
jupyter lab docs/tutorials/01-athens-quickstart.ipynb

Each notebook resolves the repository root itself, so it runs whether Jupyter is started from the repository root or from docs/tutorials/. Outputs are written to the gitignored temp/ directory.

The Madrid large-raster demo is not part of the tutorials because its LiDAR inputs are too large to ship; scripts/fetch_madrid_data.py downloads them from IGN's open data, and demos/madrid-demo.py runs the computation.

Note for contributors: the Markdown pages on this site are exported from the notebooks by poe notebooks — edit the .ipynb sources, not the .md exports.