Skip to content

modelblocks-org/module_geo_boundaries

Repository files navigation

Modelblocks - Geo-boundaries module

A module to create arbitrary regional boundary datasets for energy systems modelling

About

This is a modular snakemake workflow created as part of the Modelblocks project. It can be imported directly into any snakemake workflow.

For more information, please consult the Modelblocks documentation, the integration example, and the snakemake documentation.

Overview

Data processing steps:

  1. The configuration file is read to identify the datasets to use as well as the specific countries and regional aggregation (subtype in the configuration) to process.
  2. Individual country files are downloaded and harmonised to fit a standardised schema. Contested regions are removed at this stage.
  3. Land is clipped using maritime Exclusive Economic Zones (EEZ).
  4. Each polygon is clipped using its neighbours to minimise overlapping polygons.

Tip

The subtype naming matches that of the source database. For example, NUTS uses 0, 1, 2 and 3 (NUTS0, NUTS1, NUTS2, etc.). Use the references at the bottom of this page for more details.

Caution

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

Configuration

Please consult the configuration README and the configuration example for a general overview on the configuration options of this module.

Input / output structure

This module only has one output: a geoparquet file with your requested geo-boundary "shapes".

Please consult the interface file for more information.

Development

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

git clone git@github.com:modelblocks-org/module_geo_boundaries.git
cd module_geo_boundaries
pixi install --all

For testing, simply run:

pixi run test-integration

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!

References

This module is based on the following research and datasets. We encourage users to cite both the original source and our workflow.

About

A module to create arbitrary regional boundary datasets for energy systems modelling

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages