Merge pull request #10 from modelblocks-org/feature-small-template-update

reshuffled readme

Author: irm-codebase

.github/workflows/release.yml

@@ -6,4 +6,6 @@ on:
 
 jobs:
   release-workflow:
+    permissions:
+      contents: write
     uses: modelblocks-org/data-module-template/.github/workflows/template-release.yml@latest

README.md

@@ -2,54 +2,28 @@
 
 A module to aggregate CDR potential in Europe into flexible spatial resolutions, using the CO2Stop dataset
 
-## About this module
-<!-- Please do not modify this templated section -->
-
-This is a modular `snakemake` workflow built for [Modelblocks](https://www.modelblocks.org/) data modules.
+<!-- Place an attractive image of module outputs here -->
+<p align="center">
+  <img src="./figures/aquifer_kept.png" width="70%">
+</p>
 
-This module can be imported directly into any `snakemake` workflow.
-For more information, please consult:
-- The Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/).
-- The integration example in this repository (`tests/integration/Snakefile`).
-- The `snakemake` [documentation on modularisation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).
-
-## Development
+## About
 <!-- Please do not modify this templated section -->
 
-We use [`pixi`](https://pixi.sh/) as our package manager for development.
-Once installed, run the following to clone this repository and install all dependencies.
-
-```shell
-git clone git@github.com:modelblocks-org/module_co2stop_cdr.git
-cd module_co2stop_cdr
-pixi install --all
-```
-
-For testing, simply run:
-
-```shell
-pixi run test-integration
-```
-
-To test a minimal example of a workflow using this module:
-
-```shell
-pixi shell    # activate this project's environment
-cd tests/integration/  # navigate to the integration example
-snakemake --use-conda --cores 2  # run the workflow!
-```
+This is a modular `snakemake` workflow created as part of the [Modelblocks project](https://www.modelblocks.org/). It can be imported directly into any `snakemake` workflow.
 
-## Documentation
+For more information, please consult the Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/),
+the [integration example](./tests/integration/Snakefile),
+and the `snakemake` [documentation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).
 
-### Overview
+## Overview
 <!-- Please describe the processing stages of this module here -->
 
 The analysis of the module is structured as follows:
 
-<div style="width:50%; margin: auto;">
-
-![scenarios](./figures/rulegraph.png)
-</div>
+<p align="center">
+  <img src="./figures/rulegraph.png" width="50%">
+</p>
 
 1. The CO2Stop dataset is downloaded and cleaned up following methods described in the [JRC - CO2 transport report](https://publications.jrc.ec.europa.eu/repository/handle/JRC136709).
 2. To avoid double-counting, traps within the remaining storage units are removed as their capacity is already included in the storage unit total (please consult the [CO2Stop Final report](https://energy.ec.europa.eu/publications/assessment-co2-storage-potential-europe-co2stop_en) section 2.3.1 for details).
@@ -62,10 +36,11 @@ Additionally, the following removal criteria is applied to further clean the dat
 3. Three scenarios (`low`, `medium`, `high`) are created for each sequestration type (`aquifer`, `gas`, `oil`) for the remaining CO2Stop data.
 User-configured lower and upper bounds are applied per-polygon at this stage.
 See `bounds_mtco2: co2stop_polygons` in the configuration schema for more information.
-<div style="width:50%; margin: auto;">
 
-![scenarios](./figures/aquifer_scenarios.png)
-</div>
+<p align="center">
+  <img src="./figures/aquifer_scenarios.png" width="66%">
+</p>
+
 4. The resulting sequestration potential is aggregated per scenario into user provided shapes.
 
 >[!WARNING]
@@ -76,26 +51,51 @@ See `bounds_mtco2: co2stop_polygons` in the configuration schema for more inform
 >
 >We provide automated figures and logging (in `logs/storage_units/` and `logs/traps/`) so users can evaluate how their settings affect polygon selection.
 >Below is an example for storage unit aquifers where only undisclosed and artificial polygons have been removed. This can be seen as a _MINIMUM_ amount of removals.
-><div style="width:50%; margin: auto;">
->
->![scenarios](./figures/aquifer_kept.png)
-></div>
+> <p align="center">
+>   <img src="./figures/aquifer_kept.png" width="70%">
+> </p>
 
-### Configuration
-<!-- Feel free to describe how to configure this module below -->
+## Configuration
+<!-- Please describe how to configure this module below -->
 
 Please consult the configuration [README](./config/README.md) and the [configuration example](./config/config.yaml) for a general overview on the configuration options of this module.
 
-### Input / output structure
-<!-- Feel free to describe input / output file placement below -->
+## Input / output structure
+<!-- Please describe input / output file placement below -->
 
 As input, all you need to provide is a `.parquet` shapes file with the polygons to aggregate capacities into. This file should follow the schema provided by the [geo-boundaries module](https://github.com/calliope-project/module_geo_boundaries/tree/v0.1.6).
 
 Outputs for each input shape file can be requested per potential scenario (low, medium, high), and CDR group (aquifer, gas, oil, and total aggregate sum).
 
 Please consult the [interface file](./INTERFACE.yaml) for more information.
 
-### References
+## Development
+<!-- Please do not modify this templated section -->
+
+We use [`pixi`](https://pixi.sh/) as our package manager for development.
+Once installed, run the following to clone this repository and install all dependencies.
+
+```shell
+git clone git@github.com:modelblocks-org/module_co2stop_cdr.git
+cd module_co2stop_cdr
+pixi install --all
+```
+
+For testing, simply run:
+
+```shell
+pixi run test-integration
+```
+
+To test a minimal example of a workflow using this module:
+
+```shell
+pixi shell    # activate this project's environment
+cd tests/integration/  # navigate to the integration example
+snakemake --use-conda --cores 2  # run the workflow!
+```
+
+## References
 <!-- Please provide thorough referencing below -->
 
 This module is based on the following research and datasets: