Unify gadm download and layer

.github/workflows/ci-linux.yaml

@@ -32,18 +32,19 @@ jobs:
         shell: bash -l {0}
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v3
 
     - name: Setup Mambaforge
-      uses: conda-incubator/setup-miniconda@v2
+      uses: conda-incubator/setup-miniconda@v3
       with:
         miniforge-variant: Mambaforge
         miniforge-version: latest
         activate-environment: pypsa-earth
         use-mamba: true
 
     - name: Create environment cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       id: cache
       with:
         path: ${{ matrix.prefix }}

.github/workflows/ci-mac.yaml

@@ -30,30 +30,31 @@ jobs:
         shell: bash -l {0}
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v3
 
     # - name: Add solver to environment
     #   run: |
     #     echo -e "- glpk\n- ipopt<3.13.3" >> envs/environment.yaml
 
     - name: Setup Mambaforge
-      uses: conda-incubator/setup-miniconda@v2
+      uses: conda-incubator/setup-miniconda@v3
       with:
         miniforge-variant: Mambaforge
         miniforge-version: latest
         activate-environment: pypsa-earth
         use-mamba: true
 
     - name: Create environment cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       id: cache
       with:
         path: ${{ matrix.prefix }}
-        key: ${{ matrix.label }}-conda-${{ hashFiles('envs/environment.yaml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
+        key: ${{ matrix.label }}-conda-${{ hashFiles('envs/environment.mac.yaml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
 
     - name: Update environment due to outdated or unavailable cache
       if: steps.cache.outputs.cache-hit != 'true'
-      run: mamba env update -n pypsa-earth -f envs/environment.yaml
+      run: mamba env update -n pypsa-earth -f envs/environment.mac.yaml
 
     - name: Conda list
       run: |

.github/workflows/ci-windows.yaml

@@ -30,22 +30,23 @@ jobs:
         shell: bash -l {0}
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v3
 
     # - name: Add solver to environment
     #   run: |
     #     echo -e "- glpk\n- ipopt<3.13.3" >> envs/environment.yaml
 
     - name: Setup Mambaforge
-      uses: conda-incubator/setup-miniconda@v2
+      uses: conda-incubator/setup-miniconda@v3
       with:
         miniforge-variant: Mambaforge
         miniforge-version: latest
         activate-environment: pypsa-earth
         use-mamba: true
 
     - name: Create environment cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       id: cache
       with:
         path: ${{ matrix.prefix }}

config.default.yaml

@@ -94,6 +94,8 @@ build_shape_options:
   worldpop_method: "standard"  # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster, false (not "false") no pop addition to shape which is useful when generating only cutout
   gdp_method: "standard"  # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout
   contended_flag: "set_by_country" # "set_by_country" assigns the contended areas to the countries according to the GADM database, "drop" drops these contended areas from the model
+  gadm_file_prefix: "gadm41_"
+  gadm_url_prefix: "https://geodata.ucdavis.edu/gadm/gadm4.1/gpkg/"
 
 clean_osm_data_options:  # osm = OpenStreetMap
   names_by_shapes: true  # Set the country name based on the extended country shapes

config.tutorial.yaml

@@ -19,7 +19,7 @@ countries: ["NG", "BJ"]
   #["NG"]  # Nigeria
   #["NE"]  # Niger
   #["SL"]  # Sierra Leone
-  #["MA"]  # Morroco
+  #["MA"]  # Morocco
   #["ZA"]  # South Africa
 
 enable:
@@ -108,6 +108,8 @@ build_shape_options:
   worldpop_method: "standard"  # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster, false (not "false") no pop addition to shape which is useful when generating only cutout
   gdp_method: "standard"  # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout
   contended_flag: "set_by_country" # "set_by_country" assigns the contended areas to the countries according to the GADM database, "drop" drops these contended areas from the model
+  gadm_file_prefix: "gadm41_"
+  gadm_url_prefix: "https://geodata.ucdavis.edu/gadm/gadm4.1/gpkg/"
 
 clean_osm_data_options:
   names_by_shapes: true  # Set the country name based on the extended country shapes

envs/environment.mac.yaml

@@ -0,0 +1,87 @@
+# SPDX-FileCopyrightText:  PyPSA-Earth and PyPSA-Eur Authors
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+name: pypsa-earth
+channels:
+- conda-forge
+- bioconda
+- gurobi
+dependencies:
+- python>=3.8
+- pip
+- mamba   # esp for windows build
+
+- pypsa>=0.24, <0.25
+# - atlite>=0.2.4  # until https://github.com/PyPSA/atlite/issues/244 is not merged
+- dask
+- powerplantmatching>=0.5.7
+- earth-osm>=2.1
+- atlite
+
+  # Dependencies of the workflow itself
+- xlrd
+- openpyxl
+- seaborn
+- snakemake-minimal<8
+- memory_profiler
+- ruamel.yaml<=0.17.26
+- pytables
+- lxml
+- numpy
+- pandas
+- geopandas>=0.11.0, <=0.14.3
+- fiona!=1.8.22
+- xarray>=2023.11.0, <2023.12.0
+- netcdf4
+- networkx
+- scipy
+- pydoe2
+- shapely!=2.0.4
+- pre-commit
+- pyomo
+- matplotlib<=3.5.2
+- reverse-geocode
+- country_converter
+- pyogrio
+- numba
+- py7zr
+
+  # Keep in conda environment when calling ipython
+- ipython
+  # Jupyter notebook requirement
+- ipykernel
+- jupyterlab
+
+  # GIS dependencies:
+- cartopy
+- descartes
+- rasterio!=1.2.10
+- rioxarray
+
+ # Plotting
+- geoviews
+- hvplot
+- graphviz
+- contextily
+- graphviz
+
+  # PyPSA-Eur-Sec Dependencies
+- geopy
+- tqdm
+- pytz
+- country_converter
+
+  # Cloud download
+# - googledrivedownloader  # Commented until https://github.com/ndrplz/google-drive-downloader/pull/28 is merged: PR installed using pip
+
+# Default solver for tests (required for CI)
+- glpk
+- ipopt
+- gurobi
+
+- pip:
+  - git+https://github.com/davide-f/google-drive-downloader@master  # google drive with fix for virus scan
+  - git+https://github.com/FRESNA/vresutils@master  # until new pip release > 0.3.1 (strictly)
+  - tsam>=1.1.0
+  - chaospy  # lastest version only available on pip