Merge remote-tracking branch 'github/master'

Author: chrisjwin

.gitlab-ci.yml

@@ -3,13 +3,21 @@ image: mambaorg/micromamba
 stages:
   - test
 
-test:
+test-code:
   stage: test
   script:
-    - micromamba create -n glaes --file=requirements.yml
+    - micromamba create -n glaes --file=requirements-dev.yml
     - eval "$(micromamba shell hook --shell bash)"
     - micromamba activate glaes
     - pip install -e . --no-deps
     - pytest --cov=glaes glaes/test/
 
-
+test-formatting:
+  stage: test
+  image: pyfound/black:latest_release
+  script:
+  # Dry-run black auto-formatter. If the code needs reformatting this test
+  # will fail.
+  - black --version
+  - black --check glaes
+  - black --check Examples

Examples/00_basic_workflow.ipynb

@@ -52,7 +52,7 @@
    "outputs": [],
    "source": [
     "# Choose a region to operate on (Here, a predefined region for Aachen, Germany is used)\n",
-    "regionPath = gl._test_data_['aachenShapefile.shp']\n",
+    "regionPath = gl._test_data_[\"aachenShapefile.shp\"]\n",
     "\n",
     "# Initialize ExclusionCalculator object\n",
     "ec = gl.ExclusionCalculator(regionPath, srs=3035, pixelSize=100)"
@@ -147,7 +147,7 @@
     "clcRasterPath = gl._test_data_[\"clc-aachen_clipped.tif\"]\n",
     "\n",
     "# Apply exclusion\n",
-    "ec.excludeRasterType(clcRasterPath, value=(12,22))\n",
+    "ec.excludeRasterType(clcRasterPath, value=(12, 22))\n",
     "\n",
     "# Visualize\n",
     "ec.draw()"
@@ -194,7 +194,7 @@
    ],
    "source": [
     "# Apply exclusion\n",
-    "ec.excludeRasterType(clcRasterPath, value=(1,2), buffer=1000)\n",
+    "ec.excludeRasterType(clcRasterPath, value=(1, 2), buffer=1000)\n",
     "\n",
     "# Visualize\n",
     "ec.draw()"
@@ -404,7 +404,7 @@
     "## Apply exclusions from the given set\n",
     "ec.excludeSet(\n",
     "    exclusion_set=exclusion_set,\n",
-    "    clc=gl._test_data_['clc-aachen_clipped.tif'],\n",
+    "    clc=gl._test_data_[\"clc-aachen_clipped.tif\"],\n",
     "    osm_roads=gl._test_data_[\"aachenRoads.shp\"],\n",
     ")\n",
     "\n",
@@ -459,10 +459,10 @@
    "source": [
     "ec_p = gl.ExclusionCalculator(regionPath, srs=3035, pixelSize=100)\n",
     "\n",
-    "ec_p.excludePrior(\"agriculture_proximity\", value=(None,0))\n",
-    "ec_p.excludePrior(\"settlement_proximity\", value=(None,1000))\n",
-    "ec_p.excludePrior(\"roads_main_proximity\", value=(None,200))\n",
-    "                  \n",
+    "ec_p.excludePrior(\"agriculture_proximity\", value=(None, 0))\n",
+    "ec_p.excludePrior(\"settlement_proximity\", value=(None, 1000))\n",
+    "ec_p.excludePrior(\"roads_main_proximity\", value=(None, 200))\n",
+    "\n",
     "ec_p.draw()"
    ]
   },
@@ -507,10 +507,8 @@
    "source": [
     "## Set the initial value to those we computer previously\n",
     "ec = gl.ExclusionCalculator(\n",
-    "    regionPath, \n",
-    "    srs=3035, \n",
-    "    pixelSize=100, \n",
-    "    initialValue=\"aachens_best_pv_spots.tif\")\n",
+    "    regionPath, srs=3035, pixelSize=100, initialValue=\"aachens_best_pv_spots.tif\"\n",
+    ")\n",
     "\n",
     "\n",
     "## Draw the result\n",
@@ -546,7 +544,7 @@
     }
    ],
    "source": [
-    "ax = ec.drawWithSmopyBasemap(zoom=11, figsize=(40,20))"
+    "ax = ec.drawWithSmopyBasemap(zoom=11, figsize=(40, 20))"
    ]
   },
   {

Examples/01_Placement_algorithm.ipynb

@@ -0,0 +1 @@
+PROJCS["ETRS89_LAEA_Europe",GEOGCS["GCS_ETRS_1989",DATUM["D_ETRS_1989",SPHEROID["GRS_1980",6378137,298.257222101]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]],PROJECTION["Lambert_Azimuthal_Equal_Area"],PARAMETER["latitude_of_origin",52],PARAMETER["central_meridian",10],PARAMETER["false_easting",4321000],PARAMETER["false_northing",3210000],UNIT["Meter",1]]

Examples/aachen_placement_areas.dbf

@@ -0,0 +1 @@
+PROJCS["ETRS89_LAEA_Europe",GEOGCS["GCS_ETRS_1989",DATUM["D_ETRS_1989",SPHEROID["GRS_1980",6378137,298.257222101]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]],PROJECTION["Lambert_Azimuthal_Equal_Area"],PARAMETER["latitude_of_origin",52],PARAMETER["central_meridian",10],PARAMETER["false_easting",4321000],PARAMETER["false_northing",3210000],UNIT["Meter",1]]