Merge pull request #642 from Ahmad-Wahid/rename_build_load_data_2_bui…

…ld_electricity_demand

#624 Rename build_load_data to build_electricity_demand

doc/preparation.rst

@@ -86,13 +86,13 @@ Rule ``build_powerplants``
 .. automodule:: build_powerplants
 
 
-.. _load_data:
+.. _electricity_demand:
 
-Rule ``build_load_data``
+Rule ``build_electricity_demand``
 =============================
 
 
-.. automodule:: build_load_data
+.. automodule:: build_electricity_demand
 
 .. _ship:
 

doc/release_notes.rst

@@ -12,6 +12,8 @@ Upcoming Release
 
 * Bugfix: Correct typo in the CPLEX solver configuration in ``config.default.yaml``.
 
+* Renamed script file from PyPSA-EUR ``build_load_data`` to ``build_electricity_demand``.
+
 PyPSA-Eur 0.8.0 (18th March 2023)
 =================================
 
@@ -558,7 +560,7 @@ More OPSD integration:
   This will overwrite the capacities calculated from the heuristic approach in :func:`estimate_renewable_capacities()`
   [`#212 <https://github.com/PyPSA/pypsa-eur/pull/212>`_].
 
-* Electricity consumption data is now retrieved directly from the `OPSD website <https://data.open-power-system-data.org/time_series/2019-06-05>`_ using the rule :mod:`build_load_data`.
+* Electricity consumption data is now retrieved directly from the `OPSD website <https://data.open-power-system-data.org/time_series/2019-06-05>`_ using the rule :mod:`build_electricity_demand`.
   The user can decide whether to take the ENTSO-E power statistics data (default) or the ENTSO-E transparency data
   [`#211 <https://github.com/PyPSA/pypsa-eur/pull/211>`_].
 

doc/tutorial.rst

@@ -155,7 +155,7 @@ This triggers a workflow of multiple preceding jobs that depend on each rule's i
         19[label = "build_hydro_profile", color = "0.44 0.6 0.85", style="rounded"];
         20[label = "retrieve_cost_data", color = "0.30 0.6 0.85", style="rounded"];
         21[label = "build_powerplants", color = "0.16 0.6 0.85", style="rounded"];
-        22[label = "build_load_data", color = "0.00 0.6 0.85", style="rounded"];
+        22[label = "build_electricity_demand", color = "0.00 0.6 0.85", style="rounded"];
         23[label = "retrieve_load_data", color = "0.34 0.6 0.85", style="rounded,dashed"];
         1 -> 0
         2 -> 1
@@ -232,7 +232,7 @@ In the terminal, this will show up as a list of jobs to be run:
     base_network                    1              1              1
     build_bus_regions               1              1              1
     build_hydro_profile             1              1              1
-    build_load_data                 1              1              1
+    build_electricity_demand        1              1              1
     build_powerplants               1              1              1
     build_renewable_profiles        4              1              1
     build_shapes                    1              1              1

doc/tutorial_sector.rst

@@ -140,7 +140,7 @@ successfully.
         18[label = "retrieve_ship_raster", color = "0.15 0.6 0.85", style="rounded"];
         19[label = "retrieve_cost_data", color = "0.50 0.6 0.85", style="rounded"];
         20[label = "build_powerplants", color = "0.49 0.6 0.85", style="rounded"];
-        21[label = "build_load_data", color = "0.39 0.6 0.85", style="rounded"];
+        21[label = "build_electricity_demand", color = "0.39 0.6 0.85", style="rounded"];
         22[label = "retrieve_load_data", color = "0.05 0.6 0.85", style="rounded"];
         23[label = "build_gas_input_locations", color = "0.45 0.6 0.85", style="rounded"];
         24[label = "prepare_network", color = "0.31 0.6 0.85", style="rounded"];
@@ -367,7 +367,7 @@ implemented in the workflow:
         18[label = "retrieve_ship_raster", color = "0.09 0.6 0.85", style="rounded"];
         19[label = "retrieve_cost_data", color = "0.04 0.6 0.85", style="rounded"];
         20[label = "build_powerplants", color = "0.28 0.6 0.85", style="rounded"];
-        21[label = "build_load_data", color = "0.46 0.6 0.85", style="rounded"];
+        21[label = "build_electricity_demand", color = "0.46 0.6 0.85", style="rounded"];
         22[label = "retrieve_load_data", color = "0.44 0.6 0.85", style="rounded"];
         23[label = "build_energy_totals", color = "0.53 0.6 0.85", style="rounded"];
         24[label = "build_population_weighted_energy_totals", color = "0.03 0.6 0.85", style="rounded"];

rules/build_electricity.smk

@@ -18,19 +18,19 @@ if config["enable"].get("prepare_links_p_nom", False):
             "../scripts/prepare_links_p_nom.py"
 
 
-rule build_load_data:
+rule build_electricity_demand:
     input:
         ancient("data/load_raw.csv"),
     output:
         RESOURCES + "load.csv",
     log:
-        LOGS + "build_load_data.log",
+        LOGS + "build_electricity_demand.log",
     resources:
         mem_mb=5000,
     conda:
         "../envs/environment.yaml"
     script:
-        "../scripts/build_load_data.py"
+        "../scripts/build_electricity_demand.py"
 
 
 rule build_powerplants:

scripts/build_cop_profiles.py

@@ -12,6 +12,7 @@
 
 The quadratic regression used is based on Staffell et al. (2012)
 
+
 https://doi.org/10.1039/C2EE22653G.
 """
 

scripts/build_load_data.py → scripts/build_electricity_demand.py

@@ -276,7 +276,7 @@ def manual_adjustment(load, fn_load, powerstatistics):
     if "snakemake" not in globals():
         from _helpers import mock_snakemake
 
-        snakemake = mock_snakemake("build_load_data")
+        snakemake = mock_snakemake("build_electricity_demand")
 
     configure_logging(snakemake)
 

scripts/build_gas_network.py

@@ -29,6 +29,7 @@ def diameter_to_capacity(pipe_diameter_mm):
 
     Based on p.15 of
 
+
     https://gasforclimate2050.eu/wp-content/uploads/2020/07/2020_European-Hydrogen-Backbone_Report.pdf
     """
     # slopes definitions