Update EEZ data source to enable direct download in the workflow

CHANGELOG.md

@@ -10,7 +10,8 @@
 * **ADD** sync infrastructure to easily send and receive files to and from a cluster (#74).
 * **ADD** optional email notifications whenever builds fail or succeed (#92).
 
-* **UPDATE** ENTSOE national electricity load data gap filling priority order included in config (#42)
+* **UPDATE** EEZ is now be downloaded within the workflow, rather than depending on a manual download.
+* **UPDATE** ENTSOE national electricity load data gap filling priority order included in config (#42).
 * **UPDATE** IRENA hydro generation data from 2018 to 2020 (#40).
 * **UPDATE** Make scaling pumped hydro capacity according to Geth et al. (2015) optional with a boolean config parameter `scale-phs-according-to-geth-et-al` which defaults to False (no scaling) (#49).
 * **UPDATE** JRC hydro database v4 -> v7 (#48). This entails one patch being removed:

README.md

@@ -26,10 +26,6 @@ conda activate euro-calliope
 
 4. You need an account at the Copernicus Climate Data Service and you need to create a `$HOME/.cdsapirc` file with your credentials, see their [How To](https://cds.climate.copernicus.eu/api-how-to) (you do not need to manually install the client).
 
-5. Further, you need all data files that cannot be retrieved automatically:
-
-* [Maritime Boundaries v10 -> World Exclusive Economic Zones v10](http://www.marineregions.org/downloads.php), to be placed in `./data/World_EEZ_v10_20180221`
-
 ## Build the model
 
 Because input data is large, the actual model including its data is not part of this repository. To use the model, you first need to build it from input data and scripts. Running the build step will build the model in the `./model` folder.

config/default.yaml

@@ -1,7 +1,7 @@
 data-sources:
     biofuel-potentials: data/biofuels/potentials/{feedstock}.csv
     biofuel-costs: data/biofuels/costs/{feedstock}.csv
-    eez: data/World_EEZ_v10_20180221/eez_v10.shp
+    eez: https://geo.vliz.be/geoserver/MarineRegions/wfs?service=WFS&version=1.0.0&request=GetFeature&typeNames=MarineRegions:eez&outputFormat=SHAPE-ZIP
     irena-generation: data/irena/hydro-generation-europe.csv
     national-phs-storage-capacities: data/pumped-hydro/storage-capacities-gwh.csv
     capacity-factors: https://zenodo.org/record/3899687/files/{filename}?download=1

rules/shapes.smk

@@ -107,17 +107,28 @@ rule units_without_shape:
     script: "../scripts/shapes/nogeo.py"
 
 
+rule download_eez:
+    message: "Download Exclusive Economic Zones as zip"
+    output: protected("data/automatic/eez.zip")
+    params: url = config["data-sources"]["eez"]
+    conda: "../envs/shell.yaml"
+    shell: "curl -sLo {output} '{params.url}'"
+
+
 rule eez:
     message: "Clip exclusive economic zones to study area."
-    input: config["data-sources"]["eez"]
+    input: rules.download_eez.output[0]
     output: "build/data/eez.geojson"
     params:
         bounds="{x_min},{y_min},{x_max},{y_max}".format(**config["scope"]["bounds"]),
-        countries=",".join(["'{}'".format(country) for country in config["scope"]["countries"]])
+        countries=",".join(["'{}'".format(country) for country in config["scope"]["countries"]]),
+        temp_dir = "build/data/eez"
     conda: "../envs/geo.yaml"
     shell:
         """
-        fio cat --bbox {params.bounds} {input}\
-        | fio filter "f.properties.Territory1 in [{params.countries}]"\
+        unzip -o {input} -d {params.temp_dir}
+        fio cat --bbox {params.bounds} {params.temp_dir}/eez.shp\
+        | fio filter "f.properties.territory1 in [{params.countries}]"\
         | fio collect > {output}
+        rm -r {params.temp_dir}
         """