Merge pull request #672 from carlosfv92/Custom_powerplants_comments

Add description on custom_powerplants use
pypsa-meets-earth · Apr 11, 2023 · 64f1726 · 64f1726
2 parents 5ce8383 + f8cfeeb
commit 64f1726
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -162,24 +162,17 @@ The documentation is available here: [documentation](https://pypsa-earth.readthe
 <table>
 <tr>
     <td align="center">
-        <a href="https://github.com/hazemful">
-            <img src="https://avatars.githubusercontent.com/u/26235356?v=4" width="100;" alt="hazemful"/>
-            <br />
-            <sub><b>Null</b></sub>
-        </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/jarry7">
-            <img src="https://avatars.githubusercontent.com/u/27745389?v=4" width="100;" alt="jarry7"/>
+        <a href="https://github.com/pz-max">
+            <img src="https://avatars.githubusercontent.com/u/61968949?v=4" width="100;" alt="pz-max"/>
             <br />
-            <sub><b>Jarrad Wright</b></sub>
+            <sub><b>Max Parzen</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/fneum">
-            <img src="https://avatars.githubusercontent.com/u/29101152?v=4" width="100;" alt="fneum"/>
+        <a href="https://github.com/davide-f">
+            <img src="https://avatars.githubusercontent.com/u/67809479?v=4" width="100;" alt="davide-f"/>
             <br />
-            <sub><b>Fabian Neumann</b></sub>
+            <sub><b>Davide-f</b></sub>
         </a>
     </td>
     <td align="center">
@@ -190,20 +183,12 @@ The documentation is available here: [documentation](https://pypsa-earth.readthe
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/euronion">
-            <img src="https://avatars.githubusercontent.com/u/42553970?v=4" width="100;" alt="euronion"/>
+        <a href="https://github.com/DeniseGiub">
+            <img src="https://avatars.githubusercontent.com/u/113139589?v=4" width="100;" alt="DeniseGiub"/>
             <br />
-            <sub><b>Euronion</b></sub>
+            <sub><b>Null</b></sub>
         </a>
     </td>
-    <td align="center">
-        <a href="https://github.com/Justus-coded">
-            <img src="https://avatars.githubusercontent.com/u/44394641?v=4" width="100;" alt="Justus-coded"/>
-            <br />
-            <sub><b>Justus Ilemobayo</b></sub>
-        </a>
-    </td></tr>
-<tr>
     <td align="center">
         <a href="https://github.com/mnm-matin">
             <img src="https://avatars.githubusercontent.com/u/45293386?v=4" width="100;" alt="mnm-matin"/>
@@ -212,103 +197,75 @@ The documentation is available here: [documentation](https://pypsa-earth.readthe
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/desenk">
-            <img src="https://avatars.githubusercontent.com/u/48335263?v=4" width="100;" alt="desenk"/>
-            <br />
-            <sub><b>Desen Kirli</b></sub>
-        </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/LukasFrankenQ">
-            <img src="https://avatars.githubusercontent.com/u/55196140?v=4" width="100;" alt="LukasFrankenQ"/>
-            <br />
-            <sub><b>Lukas Franken</b></sub>
-        </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/pz-max">
-            <img src="https://avatars.githubusercontent.com/u/61968949?v=4" width="100;" alt="pz-max"/>
-            <br />
-            <sub><b>Max Parzen</b></sub>
-        </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/Cesare-Caputo">
-            <img src="https://avatars.githubusercontent.com/u/62548290?v=4" width="100;" alt="Cesare-Caputo"/>
+        <a href="https://github.com/hazemakhalek">
+            <img src="https://avatars.githubusercontent.com/u/87850910?v=4" width="100;" alt="hazemakhalek"/>
             <br />
             <sub><b>Null</b></sub>
         </a>
-    </td>
-    <td align="center">
-        <a href="https://github.com/davide-f">
-            <img src="https://avatars.githubusercontent.com/u/67809479?v=4" width="100;" alt="davide-f"/>
-            <br />
-            <sub><b>Davide-f</b></sub>
-        </a>
     </td></tr>
 <tr>
     <td align="center">
-        <a href="https://github.com/koen-vg">
-            <img src="https://avatars.githubusercontent.com/u/74298901?v=4" width="100;" alt="koen-vg"/>
+        <a href="https://github.com/energyLS">
+            <img src="https://avatars.githubusercontent.com/u/89515385?v=4" width="100;" alt="energyLS"/>
             <br />
-            <sub><b>Koen Van Greevenbroek</b></sub>
+            <sub><b>EnergyLS</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/hazemakhalek">
-            <img src="https://avatars.githubusercontent.com/u/87850910?v=4" width="100;" alt="hazemakhalek"/>
+        <a href="https://github.com/Tomkourou">
+            <img src="https://avatars.githubusercontent.com/u/5240283?v=4" width="100;" alt="Tomkourou"/>
             <br />
-            <sub><b>Null</b></sub>
+            <sub><b>Thomas Kouroughli</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/energyLS">
-            <img src="https://avatars.githubusercontent.com/u/89515385?v=4" width="100;" alt="energyLS"/>
+        <a href="https://github.com/giacfalk">
+            <img src="https://avatars.githubusercontent.com/u/36954873?v=4" width="100;" alt="giacfalk"/>
             <br />
-            <sub><b>EnergyLS</b></sub>
+            <sub><b>Giacomo Falchetta</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/AnasAlgarei">
-            <img src="https://avatars.githubusercontent.com/u/101210563?v=4" width="100;" alt="AnasAlgarei"/>
+        <a href="https://github.com/Ekaterina-Vo">
+            <img src="https://avatars.githubusercontent.com/u/99509555?v=4" width="100;" alt="Ekaterina-Vo"/>
             <br />
-            <sub><b>AnasAlgarei</b></sub>
+            <sub><b>Ekaterina-Vo</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/DeniseGiub">
-            <img src="https://avatars.githubusercontent.com/u/113139589?v=4" width="100;" alt="DeniseGiub"/>
+        <a href="https://github.com/euronion">
+            <img src="https://avatars.githubusercontent.com/u/42553970?v=4" width="100;" alt="euronion"/>
             <br />
-            <sub><b>Null</b></sub>
+            <sub><b>Euronion</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/Tomkourou">
-            <img src="https://avatars.githubusercontent.com/u/5240283?v=4" width="100;" alt="Tomkourou"/>
+        <a href="https://github.com/AnasAlgarei">
+            <img src="https://avatars.githubusercontent.com/u/101210563?v=4" width="100;" alt="AnasAlgarei"/>
             <br />
-            <sub><b>Thomas Kouroughli</b></sub>
+            <sub><b>AnasAlgarei</b></sub>
         </a>
     </td></tr>
 <tr>
     <td align="center">
-        <a href="https://github.com/giacfalk">
-            <img src="https://avatars.githubusercontent.com/u/36954873?v=4" width="100;" alt="giacfalk"/>
+        <a href="https://github.com/LukasFrankenQ">
+            <img src="https://avatars.githubusercontent.com/u/55196140?v=4" width="100;" alt="LukasFrankenQ"/>
             <br />
-            <sub><b>Giacomo Falchetta</b></sub>
+            <sub><b>Lukas Franken</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/Ekaterina-Vo">
-            <img src="https://avatars.githubusercontent.com/u/99509555?v=4" width="100;" alt="Ekaterina-Vo"/>
+        <a href="https://github.com/Tooblippe">
+            <img src="https://avatars.githubusercontent.com/u/805313?v=4" width="100;" alt="Tooblippe"/>
             <br />
-            <sub><b>Ekaterina-Vo</b></sub>
+            <sub><b>Jarrad Wright</b></sub>
         </a>
     </td>
     <td align="center">
-        <a href="https://github.com/Tooblippe">
-            <img src="https://avatars.githubusercontent.com/u/805313?v=4" width="100;" alt="Tooblippe"/>
+        <a href="https://github.com/koen-vg">
+            <img src="https://avatars.githubusercontent.com/u/74298901?v=4" width="100;" alt="koen-vg"/>
             <br />
-            <sub><b>Jarrad Wright</b></sub>
+            <sub><b>Koen Van Greevenbroek</b></sub>
         </a>
     </td>
     <td align="center">
@@ -333,6 +290,13 @@ The documentation is available here: [documentation](https://pypsa-earth.readthe
         </a>
     </td></tr>
 <tr>
+    <td align="center">
+        <a href="https://github.com/jarry7">
+            <img src="https://avatars.githubusercontent.com/u/27745389?v=4" width="100;" alt="jarry7"/>
+            <br />
+            <sub><b>Jarrad Wright</b></sub>
+        </a>
+    </td>
     <td align="center">
         <a href="https://github.com/squoilin">
             <img src="https://avatars.githubusercontent.com/u/4547840?v=4" width="100;" alt="squoilin"/>

diff --git a/envs/environment.docs.yaml b/envs/environment.docs.yaml
@@ -25,14 +25,15 @@ dependencies:
 - seaborn
 - snakemake-minimal
 - memory_profiler
+- ruamel.yaml
 - yaml
 - pytables
 - lxml
 - powerplantmatching>=0.4.8
 - numpy
 - pandas
 - geopandas
-  # - xarray  # till the main is not in conda- xarray
+- xarray
 - netcdf4
 - networkx
 - scipy
@@ -51,11 +52,13 @@ dependencies:
 - rasterio
 - geoviews
 - hvplot
+- rioxarray
 
   # PyPSA-Eur-Sec Dependencies
 - geopy
 - tqdm
 - pytz
+- reverse-geocode
 - country_converter
 
 - pip:

diff --git a/scripts/build_powerplants.py b/scripts/build_powerplants.py
@@ -6,45 +6,76 @@
 # -*- coding: utf-8 -*-
 """
 Retrieves conventional powerplant capacities and locations from `powerplantmatching <https://github.com/FRESNA/powerplantmatching>`_, assigns these to buses and creates a ``.csv`` file. It is possible to amend the powerplant database with custom entries provided in ``data/custom_powerplants.csv``.
+
 Relevant Settings
 -----------------
+
 .. code:: yaml
+
     electricity:
       powerplants_filter:
       custom_powerplants:
+
 .. seealso::
     Documentation of the configuration file ``config.yaml`` at
     :ref:`electricity`
+
 Inputs
 ------
+
 - ``networks/base.nc``: confer :ref:`base`.
 - ``data/custom_powerplants.csv``: custom powerplants in the same format as `powerplantmatching <https://github.com/FRESNA/powerplantmatching>`_ provides or as OSM extractor generates
+
 Outputs
 -------
+
 - ``resource/powerplants.csv``: A list of conventional power plants (i.e. neither wind nor solar) with fields for name, fuel type, technology, country, capacity in MW, duration, commissioning year, retrofit year, latitude, longitude, and dam information as documented in the `powerplantmatching README <https://github.com/FRESNA/powerplantmatching/blob/master/README.md>`_; additionally it includes information on the closest substation/bus in ``networks/base.nc``.
+
     .. image:: ../img/powerplantmatching.png
         :scale: 30 %
+
     **Source:** `powerplantmatching on GitHub <https://github.com/FRESNA/powerplantmatching>`_
+
 Description
 -----------
+
 The configuration options ``electricity: powerplants_filter`` and ``electricity: custom_powerplants`` can be used to control whether data should be retrieved from the original powerplants database or from custom amendmends. These specify `pandas.query <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.query.html>`_ commands.
 1. Adding all powerplants from custom:
+
     .. code:: yaml
+
         powerplants_filter: false
         custom_powerplants: true
+
 2. Replacing powerplants in e.g. Germany by custom data:
+
     .. code:: yaml
+
         powerplants_filter: Country not in ['Germany']
         custom_powerplants: true
+
     or
+
     .. code:: yaml
+
         powerplants_filter: Country not in ['Germany']
         custom_powerplants: Country in ['Germany']
+
 3. Adding additional built year constraints:
+
     .. code:: yaml
+
         powerplants_filter: Country not in ['Germany'] and YearCommissioned <= 2015
         custom_powerplants: YearCommissioned <= 2015
 
+Format required for the custom_powerplants.csv should be similar to the powerplantmatching format with some additional considerations: 
+Columns required: [id, Name, Fueltype, Technology, Set, Country, Capacity, Efficiency, DateIn, DateRetrofit, DateOut, lat, lon, Duration, Volume_Mm3, DamHeight_m, StorageCapacity_MWh, EIC, projectID]
+
+Tagging considerations for columns in the file:
+    - FuelType: 'Natural Gas' has to be tagged either as 'OCGT', 'CCGT'
+    - Technology: 'Reservoir' has to be set as 'ror' if hydro powerplants are to be considered as 'Generators' and not 'StorageUnits'
+    - Country:  Country name has to be defined with its alpha2 code ('NG' for Nigeria,'BO' for Bolivia, 'FR' for France, etc.)
+
 The following assumptions were done to map custom OSM-extracted power plants with powerplantmatching format.
 1. The benchmark PPM keys values were taken as follows:
         'Fueltype': ['Hydro', 'Hard Coal', 'Natural Gas', 'Lignite', 'Nuclear', 'Oil', 'Bioenergy'
@@ -60,7 +91,6 @@
         'nuclear': 'Steam Turbine'
 3. All hydro OSM-extracted objects were interpreted as generation technologies, although ["Run-Of-River", "Pumped Storage", "Reservoir"] in PPM can belong to 'Storage Technologies', too.
 4. OSM extraction was supposed to be ignoring non-generation features like CHP and Natural Gas storage (in contrast to PPM).
-
 """
 import logging
 import os

diff --git a/scripts/simplify_network.py b/scripts/simplify_network.py
@@ -13,9 +13,10 @@
 -----------------
 
 .. code:: yaml
+
     clustering:
-      simplify:
-      aggregation_strategies:
+        simplify:
+        aggregation_strategies:
 
     costs:
         year: