From 9fd2af60abc5df88fd68a7f8cb5bb4339f3c4ab5 Mon Sep 17 00:00:00 2001
From: Davide Fioriti <67809479+davide-f@users.noreply.github.com>
Date: Sat, 5 Aug 2023 16:12:09 +0200
Subject: [PATCH] Add full African and North American cutouts (#813)

* Add full African and North American cutouts

* Add release note

* Add Earth bundle

* Add Earth cutout

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revise description bundles

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
---
 configs/bundle_config.yaml | 44 ++++++++++++++++++++++++++++++++++++--
 doc/release_notes.rst      |  2 ++
 2 files changed, 44 insertions(+), 2 deletions(-)

diff --git a/configs/bundle_config.yaml b/configs/bundle_config.yaml
index 48db64f60..2b27b1a61 100644
--- a/configs/bundle_config.yaml
+++ b/configs/bundle_config.yaml
@@ -272,8 +272,9 @@ databundles:
   #       agree: 1
   #   output: [data/gebco/GEBCO_2021_TID.nc]
 
-  # cutouts bundle of the cutouts folder for the African continent
-  bundle_cutouts_africa:
+  # cutouts bundle of the cutouts folder for the mainland African continent
+  # Note: some offshore countries e.g. CV or SC are not covered. Size: about 10GB (zipped)
+  bundle_cutouts_mainland_africa:
     countries: [Africa]
     category: cutouts
     destination: "cutouts"
@@ -283,3 +284,42 @@ databundles:
     output: [cutouts/cutout-2013-era5.nc]
     disable_by_opt:
       build_cutout: [all]
+
+  # # cutouts bundle of the cutouts folder for the whole African continent,
+  # # including UN countries offshore mainland Africa. Size about 20GB (zipped)
+  # bundle_cutouts_whole_africa:
+  #   countries: [Africa]
+  #   category: cutouts
+  #   destination: "cutouts"
+  #   urls:
+  #     # zenodo:
+  #     gdrive: https://drive.google.com/file/d/1O_9vQ2SDluJ_LtFdRBeoo1Pz213n5HAN/view?usp=sharing
+  #   output: [cutouts/cutout-2013-era5.nc]
+  #   disable_by_opt:
+  #     build_cutout: [all]
+
+  # cutouts bundle of the cutouts folder for the North American continent
+  # Note: this includes nearly the entire north emisphere [long +-180, lat 1-85]. Size about 81GB (zipped)
+  bundle_cutouts_northamerica:
+    countries: [NorthAmerica, Europe]
+    category: cutouts
+    destination: "cutouts"
+    urls:
+      # zenodo:
+      gdrive: https://drive.google.com/file/d/1Ew7rQT0VNBqJW1AUrOrOP2IJKSJS7Uoy/view?usp=sharing
+    output: [cutouts/cutout-2013-era5.nc]
+    disable_by_opt:
+      build_cutout: [all]
+
+  # # cutouts bundle of the cutouts folder for the entire globe [long +-180, lat +-89.9]
+  # # commented by default to avoid downloading by mistake. Size about 170GB (zipped)
+  # bundle_cutouts_earth:
+  #   countries: [Earth]
+  #   category: cutouts
+  #   destination: "cutouts"
+  #   urls:
+  #     # zenodo:
+  #     gdrive: https://drive.google.com/file/d/1C9Q5qU_Wu_gj78H5G3TT2thGA-hKheVf/view?usp=drive_link
+  #   output: [cutouts/cutout-2013-era5.nc]
+  #   disable_by_opt:
+  #     build_cutout: [all]
diff --git a/doc/release_notes.rst b/doc/release_notes.rst
index 1a6cdcde5..a28eddb9e 100644
--- a/doc/release_notes.rst
+++ b/doc/release_notes.rst
@@ -26,6 +26,8 @@ E.g. if a new rule becomes available describe how to use it `snakemake -j1 run_t
 
 * Support renewables or renewable expansion to meet a desired share of total load. `PR #793 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/793>`__
 
+* Add NorthAmerican and Earth cutouts, and improve African cutout `PR #813 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/813>`__
+
 PyPSA-Earth 0.2.2
 =================