Simplify and generalise the area potential processing; Cleanup

Author: sjpfenninger

config/config.yaml

@@ -4,42 +4,73 @@
 #   A good option is "epsg:8857" (WGS 84 / Equal Earth Greenwich) for global coverage
 buffer_crs: "epsg:8857"
 
-# Technical criteria
-techs_onshore:
+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:
-    max_slope: 3
-    land_cover:
-      FARM: 0.1
-      FOREST: 0  # no PV open field in forest
-      OTHER: 0.2
-      URBAN: 0  # no PV open field in urban
-    settlement:
-      max_settlement: 0.01 # no PV open field in settlement
-      weight: -1
+    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:
-    max_slope: 20
-    land_cover:
-      FARM: 0.2
-      FOREST: 0.05
-      OTHER: 0.3
-      URBAN: 0  # no wind onshore in urban
-    settlement:
-      max_settlement: 0.01
-      weight: -1
-  pv_rooftop:
-    max_slope: 90
-    land_cover:
-      FARM: 0
-      FOREST: 0
-      OTHER: 0
-      URBAN: 1
-    settlement:
-      max_settlement: 1
-      weight: 0.8
-
-techs_offshore:
+    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:
-    water_depth:
-      max: 0
-      min: -50
-    weight: 0.8
+    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/Snakefile

@@ -22,8 +22,7 @@ workflow.source_path("scripts/geo.py")
 
 wildcard_constraints:
     shape="[a-zA-Z0-9_-]+",
-    tech_onshore="|".join(config["techs_onshore"].keys()),
-    tech_offshore="|".join(config["techs_offshore"].keys()),
+    tech="|".join(config["techs"].keys()),
 
 # Add all your includes here.
 include: "rules/automatic.smk"

workflow/internal/config.schema.yaml

@@ -16,41 +16,29 @@ properties:
     required: [projection, resolution]
     additionalProperties: false
 
-  techs_onshore:
+  techs:
     type: object
     additionalProperties:
       type: object
       properties:
-        max_slope:
-          type: number
-        land_cover:
+        initial_area:
+          type: string
+          enum: ["settlement_area", "pixel_area"]
+        continuous_layers:
           type: object
           additionalProperties:
-            type: number
-        settlement:
-          type: object
-          properties:
-            max_settlement:
-              type: number
-            weight:
-              type: number
-          required: [max_settlement, weight]
-          additionalProperties: false
-      required: [max_slope, land_cover, settlement]
-      additionalProperties: false
-
-  techs_offshore:
-    type: object
-    additionalProperties:
-      type: object
-      properties:
-        water_depth:
+            type: object
+            properties:
+              min:
+                type: number
+              max:
+                type: number
+            required: ["min", "max"]
+        binary_layers:
           type: object
           additionalProperties:
             type: number
-        weight:
-          type: number
-      required: [water_depth, weight]
-      additionalProperties: false
-
-required: [techs_onshore, techs_offshore]
+        shapes_buffer:
+          type: object
+      required: ["initial_area", "continuous_layers", "binary_layers"]
+      additionalProperties: false

workflow/rules/automatic.smk

@@ -8,7 +8,7 @@ rule download_cutout_slope:
     input:
         vector="resources/user/shapes/{shape}.parquet",
     output:
-        path="resources/cutout/{shape}/slope.tif",
+        path="resources/automatic/cutout/{shape}/slope.tif",
     wrapper:
         "v7.2.0/geo/rasterio/clip-geotiff"
 
@@ -20,7 +20,7 @@ rule download_cutout_bathymetry:
     input:
         vector="resources/user/shapes/{shape}.parquet",
     output:
-        path="resources/cutout/{shape}/bathymetry.tif",
+        path="resources/automatic/cutout/{shape}/bathymetry.tif",
     wrapper:
         "v7.2.0/geo/rasterio/clip-geotiff"
 
@@ -30,7 +30,7 @@ rule download_wdpa:
     params:
         url=internal["resources"]["automatic"]["wdpa"],
     output:
-        "resources/automatic/wdpa.zip",
+        "resources/automatic/global/wdpa.zip",
     conda:
         "../envs/shell.yaml"
     shell:
@@ -44,7 +44,7 @@ rule unzip_wdpa:
     input:
         rules.download_wdpa.output,
     output:
-        directory("resources/automatic/wdpa.gdb"),
+        directory("resources/automatic/global/wdpa.gdb"),
     conda:
         "../envs/shell.yaml"
     shell:
@@ -61,7 +61,7 @@ rule download_globcover:
     params:
         url=internal["resources"]["automatic"]["globcover"],
     output:
-        "resources/automatic/globcover.zip",
+        "resources/automatic/global/globcover.zip",
     conda:
         "../envs/shell.yaml"
     shell:
@@ -75,7 +75,7 @@ rule unzip_globcover:
     input:
         rules.download_globcover.output,
     output:
-        "resources/automatic/globcover-landcover.tif",
+        "resources/automatic/global/globcover-landcover.tif",
     log:
         "logs/unzip_globcover.log",
     conda:
@@ -94,7 +94,7 @@ rule download_ghsl:
     params:
         url=internal["resources"]["automatic"]["ghsl"],
     output:
-        "resources/automatic/ghsl_built_s.zip",
+        "resources/automatic/global/ghsl_built_s.zip",
     conda:
         "../envs/shell.yaml"
     shell:
@@ -108,7 +108,7 @@ rule unzip_ghsl:
     input:
         rules.download_ghsl.output,
     output:
-        "resources/automatic/ghsl_built_s.tif",
+        "resources/automatic/global/ghsl_built_s.tif",
     conda:
         "../envs/shell.yaml"
     shell:

workflow/rules/prepare.smk

@@ -7,7 +7,7 @@ rule cutout_landcover:
         shapes="resources/user/shapes/{shape}.parquet",
         landcover=rules.unzip_globcover.output,
     output:
-        "resources/cutout/{shape}/landcover.tif",
+        "resources/automatic/cutout/{shape}/landcover.tif",
     conda:
         "../envs/default.yaml"
     shell:
@@ -23,7 +23,7 @@ rule cutout_settlement:
         shapes="resources/user/shapes/{shape}.parquet",
         settlement=rules.unzip_ghsl.output,
     output:
-        "resources/cutout/{shape}/settlement.tif",
+        "resources/automatic/cutout/{shape}/settlement.tif",
     conda:
         "../envs/default.yaml"
     shell:

workflow/rules/process.smk

@@ -1,4 +1,4 @@
-rule resample_same_resolution:
+rule prepare_resampled_inputs:
     message:
         "Resample inputs for {wildcards.shape} to the projection and resolution of the land cover data, while aggregating land cover types.",
     input:
@@ -10,9 +10,9 @@ rule resample_same_resolution:
         bathymetry_path=rules.download_cutout_bathymetry.output,
         protected_area_path=rules.unzip_wdpa.output,
     output:
-        resampled_input="resources/{shape}/resampled_inputs.nc",
+        resampled_input="resources/automatic/{shape}.resampled_inputs.nc",
         plot=report(
-            "resources/{shape}/resampled_inputs.png",
+            "resources/automatic/{shape}.resampled_inputs.png",
             category="resampled_input",
         ),
     conda:
@@ -24,92 +24,40 @@ rule resample_same_resolution:
         "{output.resampled_input}" "{output.plot}"
         """
 
-rule technical_mask_onshore:
+rule area_potential:
     message:
-        "Get fraction satisfied all technical criteria: not too steep slope, suitable land cover, and not exceeding max_settlement for the tech {wildcards.tech_onshore} and shape {wildcards.shape}.",
+        "Compute area potential for the tech {wildcards.tech} and shapes {wildcards.shape}."
     params:
-        suitable_land_cover_types=lambda wildcards: config["techs_onshore"][f"{wildcards.tech_onshore}"]["land_cover"],
-        max_slope=lambda wildcards: config["techs_onshore"][f"{wildcards.tech_onshore}"]["max_slope"],
-        max_settlement=lambda wildcards: config["techs_onshore"][f"{wildcards.tech_onshore}"]["settlement"]["max_settlement"],
-    input:
-        script=workflow.source_path("../scripts/apply_technical_mask.py"),
-        resampled_path=rules.resample_same_resolution.output.resampled_input,
-    output:
-        technical_mask="resources/{shape}/technical_mask_{tech_onshore}.nc",
-        # plot=report(
-        #     "resources/{shape}/technical_mask_{tech_onshore}.pdf",
-        #     category="technical_mask",
-        # ),
-    conda:
-        "../envs/default.yaml"
-    shell:
-        """
-        python "{input.script}" "{input.resampled_path}" "{params.suitable_land_cover_types}" "{params.max_slope}" "{params.max_settlement}" "{output}"
-        """
-
-rule area_potential_onshore:
-    message:
-        "Compute onshore area potential for the tech {wildcards.tech_onshore} and shape {wildcards.shape}."
-    params:
-        technical_mask=lambda wildcards: config["techs_onshore"][f"{wildcards.tech_onshore}"]
-    input:
-        script=workflow.source_path("../scripts/potential_onshore.py"),
-        shapes="resources/user/shapes/{shape}.parquet",
-        masked_path=rules.technical_mask_onshore.output.technical_mask,
-    output:
-        area_potential="results/{shape}/area_potential_{tech_onshore}.tif",
-        plot=report(
-            "results/{shape}/area_potential_{tech_onshore}.png",
-            category="area_potential",
-        ),
-    conda:
-        "../envs/default.yaml"
-    shell:
-        """
-        python "{input.script}" "{input.masked_path}" "{params.technical_mask}" "{input.shapes}" "{output.area_potential}" "{output.plot}"
-        """
-
-rule area_potential_offshore:
-    message:
-        "Compute offshore area potential for the tech {wildcards.tech_offshore} and shape {wildcards.shape}."
-    params:
-        water_depth=lambda wildcards: config["techs_offshore"][f"{wildcards.tech_offshore}"]["water_depth"],
-        weight=lambda wildcards: config["techs_offshore"][f"{wildcards.tech_offshore}"]["weight"],
+        config=lambda wildcards: config["techs"][f"{wildcards.tech}"],
         buffer_crs=lambda wildcards: config["buffer_crs"],
     input:
-        script=workflow.source_path("../scripts/potential_offshore.py"),
+        script=workflow.source_path("../scripts/area_potential.py"),
         shapes="resources/user/shapes/{shape}.parquet",
-        resampled_input_path=rules.resample_same_resolution.output.resampled_input,
+        resampled_path=rules.prepare_resampled_inputs.output.resampled_input,
     output:
-        area_potential="results/{shape}/area_potential_{tech_offshore}.tif",
+        area_potential="results/{shape}/area_potential_{tech}.tif",
         plot=report(
-            "results/{shape}/area_potential_{tech_offshore}.png",
+            "results/{shape}/area_potential_{tech}.png",
             category="area_potential",
         ),
-    log:
-        "logs/area_potential_{shape}_{tech_offshore}.log",
     conda:
         "../envs/default.yaml"
     shell:
         """
-        python "{input.script}" "{input.shapes}" \
-        "{params.water_depth}" "{input.resampled_input_path}" "{params.weight}" "{params.buffer_crs}" "{output.area_potential}" "{output.plot}" 2> "{log}"
+        set -x
+        python "{input.script}" "{input.shapes}" "{input.resampled_path}" "{params.config}" "{params.buffer_crs}" "{output.area_potential}" "{output.plot}"
         """
 
-
 rule area_potential_report:
     message:
-        "Generate an overview report of the area potential for all techs in shape {wildcards.shape}.",
+        "Generate an overview report of the area potential for all techs in shapes {wildcards.shape}.",
     input:
         shapes="resources/user/shapes/{shape}.parquet",
-        resampled_path=rules.resample_same_resolution.output.resampled_input,
+        resampled_path=rules.prepare_resampled_inputs.output.resampled_input,
         area_potentials=expand(
             "results/{{shape}}/area_potential_{tech}.tif",
-            tech=config["techs_offshore"].keys(),
-        ) + expand(
-            "results/{{shape}}/area_potential_{tech}.tif",
-            tech=config["techs_onshore"].keys(),
-        ),
+            tech=config["techs"].keys(),
+        )
     output:
         csv="results/{shape}/area_potential_report.csv",
         html=report(