Feature full rules

AUTHORS

@@ -4,4 +4,5 @@ This does not necessarily list everyone who has contributed to this software's
 code or documentation. For a full contributor list, see:
 <https://github.com/calliope-project/module_area_potentials/graphs/contributors>
 
+Linh Ho-Tran, <L.Ho@tudelft.nl>
 Stefan Pfenninger-Lee, <s.pfenninger@tudelft.nl>

CITATION.cff

@@ -7,5 +7,7 @@ title: "clio - module_area_potentials: Area potentials"
 repository: "https://github.com/calliope-project/module_area_potentials"
 license: Apache-2.0
 authors:
+  - given-names: Linh
+    family-names: Ho-Tran
   - given-names: Stefan
     family-names: Pfenninger-Lee

INTERFACE.yaml

@@ -1,20 +1,15 @@
 # Module Input-Output structure for automated doc. generation
 resources:
   user:
-    user_message.md: "Example file emulating external files requested from a user."
+    "shapes/{shape}.parquet": "Region geometries in parquet format. These should conform to the schema defined in https://github.com/calliope-project/module_geo_boundaries/blob/main/workflow/internal/shape.schema.yaml"
+    "wdpa.gdb": "WDPA protected areas database from https://www.protectedplanet.net/ in GeoDB format (choose 'File Geodatabase' when downloading)."
   automatic:
-    dummy_readme.md: "Example file emulating downloads determined by internal settings."
+    "{shape}.resampled_inputs.nc": "Resampled and rasterized input data layers for the regions, including land cover, slope, settlement, bathymetry, and protected areas."
+    "{shape}.resampled_inputs.png": "Visualization of the resampled input data for the regions."
 results:
-  combined_text.md: "Example file emulating module results."
-
-# Wildcard example:
-# resources:
-#   user:
-#     shapes_{resolution}.geojson: region geometries.
-#   automatic:
-#     technology_data.parquet: dataset with technology characteristics.
-# results:
-#   '{resolution}/tech_capacity.parquet': description of output data.
-#   '{resolution}/results_image.png': description of output image.
-# wildcards:
-#   resolution: description of the wildcard’s purpose.
+    "results/{shape}/area_potential_{tech}.tif": "Area potential GeoTIFF raster for the specified technology and region geometries."
+    "results/{shape}/area_potential_report.csv": "CSV summary report of area potential for all techs, for the given region geometries."
+    "results/{shape}/area_potential_report.html": "HTML summary report of area potential for all techs, for the given region geometries."
+wildcards:
+  shape: "Name of the shape to be processed, e.g., 'world', 'europe', 'MEX'."
+  tech: "Name of the technology, e.g., 'pv_rooftop' or 'wind_offshore'. Available technologies are defined in the module configuration."

README.md

@@ -23,7 +23,7 @@ pixi install --all
 For testing, simply run:
 
 ```shell
-pixi run test
+pixi run test-integration
 ```
 
 To view the documentation locally, use:
@@ -37,5 +37,5 @@ 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  # run the workflow!
+snakemake --use-conda --cores 2  # run the workflow!
 ```

config/config.yaml

@@ -1,2 +1,119 @@
-# A minimal example of how to configure this module
-dummy_text: This is a user input.
+tiny_files: False
+
+# Options for buffering: either a string of the form "epsg:xxxx" or "UTM"/"utm"
+# - "UTM": project each shape to the UTM zone of its centroid for buffering
+# - "epsg:xxxx": use the specified CRS for all buffering
+#   A good option is "epsg:8857" (WGS 84 / Equal Earth Greenwich) for global coverage
+buffer_crs: "epsg:8857"
+
+split_by: country_id  # likely country_id or shape_id
+
+land_cover_types:
+  POST_FLOODING: FARM
+  RAINFED_CROPLANDS: FARM
+  MOSAIC_CROPLAND: FARM
+  MOSAIC_VEGETATION: FARM
+  CLOSED_TO_OPEN_BROADLEAVED_FOREST: FOREST
+  CLOSED_BROADLEAVED_FOREST: FOREST
+  OPEN_BROADLEAVED_FOREST: FOREST
+  CLOSED_NEEDLELEAVED_FOREST: FOREST
+  OPEN_NEEDLELEAVED_FOREST: FOREST
+  CLOSED_TO_OPEN_MIXED_FOREST: FOREST
+  MOSAIC_FOREST: FOREST
+  CLOSED_TO_OPEN_REGULARLY_FLOODED_FOREST: FOREST
+  CLOSED_REGULARLY_FLOODED_FOREST: FOREST
+  MOSAIC_GRASSLAND: OTHER
+  CLOSED_TO_OPEN_SHRUBLAND: OTHER
+  CLOSED_TO_OPEN_HERBS: OTHER
+  SPARSE_VEGETATION: OTHER
+  CLOSED_TO_OPEN_REGULARLY_FLOODED_GRASSLAND: OTHER
+  BARE_AREAS: OTHER
+  ARTIFICIAL_SURFACES_AND_URBAN_AREAS: URBAN
+  WATER_BODIES: WATER
+  PERMANENT_SNOW: NOT_SUITABLE
+  NO_DATA: NOT_SUITABLE
+
+techs:
+  pv_rooftop:
+    initial_area: settlement_area
+    continuous_layers:
+      settlement_share:
+        min: 0.01
+        max: 1
+        share: 0.8
+    binary_layers:
+      regions_maritime: 0
+      regions_land: 1
+      protected: 0
+      # Include all land cover types; selection is done by settlement_share
+      landcover_FARM: 1
+      landcover_FOREST: 1
+      landcover_URBAN: 1
+      landcover_OTHER: 1
+      landcover_NOT_SUITABLE: 0
+      landcover_WATER: 0
+  pv_open_field:
+    initial_area: pixel_area
+    continuous_layers:
+      slope:
+        min: 0
+        max: 3
+      settlement_share:
+        min: 0
+        max: 0.01
+    binary_layers:
+      regions_maritime: 0
+      regions_land: 1
+      protected: 0
+      landcover_FARM: 0.1
+      landcover_FOREST: 0
+      landcover_URBAN: 0
+      landcover_OTHER: 0.2
+      landcover_NOT_SUITABLE: 0
+      landcover_WATER: 0
+  wind_onshore:
+    initial_area: pixel_area
+    continuous_layers:
+      slope:
+        min: 0
+        max: 20
+      settlement_share:
+        min: 0
+        max: 0.01
+    binary_layers:
+      regions_maritime: 0
+      regions_land: 1
+      protected: 0
+      landcover_FARM: 0.2
+      landcover_FOREST: 0.05
+      landcover_URBAN: 0
+      landcover_OTHER: 0.3
+      landcover_NOT_SUITABLE: 0
+      landcover_WATER: 0
+  wind_offshore:
+    initial_area: pixel_area
+    continuous_layers:
+      bathymetry:
+        min: -50
+        max: 0
+        share: 0.8
+    binary_layers:
+      regions_land: 0
+      regions_maritime: 1
+      protected: 0
+    shapes_buffer:
+      land: 10000  # meters
+
+# Optional: override settings for specific subunits (countries, regions, etc.)
+# This allows you to set specific parameters that differ from the defaults,
+# or apply settings that are not defined in the defaults (defaults = `techs` section).
+# The subunit keys should match the subunit IDs used in column selected in `split_by`.
+overrides:
+  PRT:  # Inside a subunit, any setting from `techs` can be overridden
+    wind_offshore:
+      shapes_buffer:
+        land: 2000  # meters
+  NLD:
+    wind_offshore:
+      shapes_buffer:
+        land: 22000  # 22 km = 12 nautical miles

docs/index.md

@@ -2,3 +2,17 @@
 
 Welcome to the documentation of the `module_area_potentials` data module!
 Please consult the [specification guidelines](./specification.md) and the [`clio` documentation](https://clio.readthedocs.io/) for more information.
+
+
+## Data sources
+
+* [GEDTM30](https://github.com/openlandmap/GEDTM30) for slope
+    * License: Creative Commons Attribution 4.0 International
+* [GlobCover land cover data](https://due.esrin.esa.int/page_globcover.php)
+    * License: "You may use the GlobCover land cover map for educational and/or scientific purposes, without any fee on the condition that you credit ESA and the Université Catholique de Louvain as the source of the GlobCover products."
+* [GEBCO (General Bathymetric Chart of the Oceans)](https://www.gebco.net/data-products/gridded-bathymetry-data) 15 arc-second data
+    * License: "The GEBCO Grid is placed in the public domain and may be used free of charge. [...] Users must: Acknowledge the source of The GEBCO Grid. A suitable form of attribution is given in the documentation that accompanies The GEBCO Grid."
+* [GHSL (Global Human Settlement Layer)](https://human-settlement.emergency.copernicus.eu/download.php) built-up surface data (R2023, GHS-BUILT-S, 100m resolution)
+    * License: "The GHSL has been produced by the EC JRC as open and free data. Reuse is authorised, provided the source is acknowledged."
+* [WDPA (World Database on Protected Areas)](https://www.protectedplanet.net/)
+    * License: Non-commercial allowed. Citation: "UNEP-WCMC and IUCN (2025), Protected Planet: The World Database on Protected Areas (WDPA) and World Database on Other Effective Area-based Conservation Measures (WD-OECM) [Online], June 2025, Cambridge, UK: UNEP-WCMC and IUCN. Available at: www.protectedplanet.net."