clio - Geo-boundaries module

A data module to create arbitrary regional boundaries for energy systems modelling.

A modular snakemake workflow built for clio data modules.

Steps

1. Data is downloaded and harmonized using a common schema.
   • Country area data: GADM, Overture Maps and NUTS divisions are supported as datasources.
   • Marine regions Exclusive Economic Zone (EEZ) data.
2. Country area is clipped using the marine regions to accurately approximate their landmass.
3. The marine data and the clipped land mass data are combined following the schema. Contested EEZ's (e.g., Taiwan, Falkland islands) are removed during this step.

Caution

To increase the replicability of your workflow, recommend using NUTS and GADM as sources whenever possible as they are more stable than Overture Maps.

Using this module

This module can be imported directly into any snakemake workflow. Please consult the integration example in tests/integration/Snakefile for more information.

Development

We use pixi as our package manager for development. Once installed, run the following to clone this repo and install all dependencies.

git clone [email protected]:calliope-project/module_geo_boundaries.git
cd module_geo_boundaries
pixi install --all

For testing, simply run:

pixi run test-integration

To view the documentation locally, use:

pixi run serve-docs

To test a minimal example of a workflow using this module:

pixi shell    # activate this project's environment
cd tests/integration/  # navigate to the integration example
snakemake --use-conda --cores 2  # run the workflow!