Area potentials

A modular snakemake workflow built for clio data modules.

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 git@github.com:calliope-project/module_area_potentials.git
cd module_area_potentials
pixi install --all

For testing, simply run:

pixi run test

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  # run the workflow!