Add integration test

Author: sjpfenninger

tests/integration/Snakefile

@@ -1,21 +1,25 @@
 # Emulate a user configuring the module.
 configfile: workflow.source_path("./test_config.yaml")
 
-# Emulate how another workflow might create inputs for this module.
-rule create_external_input:
-    message: "Example of a rule external to your module."
+rule download_netherlands_shapes:
+    message: "Download and unzip the Netherlands shapes."
     output:
-        text_file = "results/module_area_potentials/resources/user/user_message.md"
-    run:
-        from pathlib import Path
-        from textwrap import dedent
-        text = dedent("""Modular workflows can be used by more than one project!
-            For example, this text comes from a file external to the module.
-            Try your best to make this workflow reusable so that others may benefit from your methods."""
-        )
-        file_path = Path(output.text_file)
-        with file_path.open("w") as f:
-            f.write(text)
+        "results/module_area_potentials/resources/user/shapes/NLD.parquet",
+    shell:
+        """
+        curl -sSLo {output} https://surfdrive.surf.nl/files/index.php/s/ey3RmiCbajp69oQ/download
+        """
+
+rule download_netherlands_protected_areas:
+    message: "Download and unzip a dummy drop-in dataset for Netherlands protected areas (not based on WDPA)."
+    output:
+        zipfile="results/module_area_potentials/resources/user/wdpa.gdb.zip",
+        wdpa=directory("results/module_area_potentials/resources/user/wdpa.gdb"),
+    shell:
+        """
+        curl -sSLo {output.zipfile} https://surfdrive.surf.nl/files/index.php/s/msuXQETNbCWawDh/download
+        unzip {output.zipfile} -d results/module_area_potentials/resources/user/
+        """
 
 # Import the module and configure it.
 # `snakefile:` specifies the module. It can use file paths and special github(...) / gitlab(...) markers
@@ -30,7 +34,9 @@ use rule * from module_area_potentials as module_area_potentials_*
 
 # Request something from the module
 rule all:
-    message: "A generic test case for your module."
+    message: "Run the module for the Netherlands shapes."
     default_target: True
     input:
-        "results/module_area_potentials/results/combined_text.md"
+        "results/module_area_potentials/resources/user/shapes/NLD.parquet",
+        "results/module_area_potentials/resources/user/wdpa.gdb",
+        "results/module_area_potentials/results/NLD/area_potential_report.html",

tests/integration/test_config.yaml

@@ -1,4 +1,77 @@
 module_area_potentials:
-  dummy_text: >-
-    Configuration values (like this one) are also external to the module!
-    This gives users a lot of flexibility in how they apply your methodology to solve their particular needs.
+  # 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"
+
+  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

workflow/rules/prepare.smk

@@ -15,7 +15,6 @@ rule cutout_landcover:
         rio clip --overwrite "{input.landcover}" "{output}" --bounds "$(fio info '{input.shapes}' --bounds)"
         """
 
-
 rule cutout_settlement:
     message:
         "Cut settlement data to the bounds of the input shapefile."