fill in relevant settings sections

scripts/add_electricity.py

@@ -5,6 +5,37 @@ Adds electrical generators and storage units to base network
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    costs:
+        year:
+        USD2013_to_EUR2013:
+        dicountrate:
+        emission_prices:
+
+    electricity:
+        max_hours:
+        marginal_cost:
+        capital_cost:
+        conventional_carriers:
+        co2limit:
+        extendable_carriers:
+            Generator:
+            StorageUnit:
+        estimate_renewable_capacities_from_capacity_stats:
+
+    load:
+        scaling_factor:
+
+    renewable: (keys)
+        hydro:
+            carriers:
+            hydro_max_hours:
+            hydro_capital_cost:
+
+    lines:
+        length_factor:
+
 Inputs
 ------
 

scripts/base_network.py

@@ -5,6 +5,30 @@ Creates the network topology from ENTSO-E map extracts as a PyPSA network
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    snapshots:
+
+    countries:
+
+    electricity:
+        voltages:
+
+    lines:
+        types:
+        s_max_pu:
+        under_construction:
+        
+    links:
+        p_max_pu:
+        under_construction:
+        include_tyndp:
+        
+    transformers:
+        x:
+        s_nom:
+        type:
+        
 Inputs
 ------
 

scripts/build_bus_regions.py

@@ -4,6 +4,11 @@ Creates onshore and offshore Voronoi shapes for each bus
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    countries:
+
+
 Inputs
 ------
 

scripts/build_country_flh.py

@@ -5,6 +5,16 @@ Create csv files and plots for comparing per country full load hours of renewabl
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    snapshots:
+
+    renewable:
+        {technology}:
+            cutout:
+            resource:
+            correction_factor:
+
 Inputs
 ------
 

scripts/build_cutout.py

@@ -4,6 +4,13 @@ Create cutouts configured in `atlite` config section
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    atlite:
+        nprocesses:
+        cutouts:
+            {cutout}:
+
 Inputs
 ------
 

scripts/build_hydro_profile.py

@@ -5,6 +5,15 @@ Build hydroelectric inflow time-series for each country
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    countries:
+
+    renewable:
+        hydro:
+            cutout:
+            clip_min_inflow:
+
 Inputs
 ------
 

scripts/build_natura_raster.py

@@ -4,6 +4,12 @@ Rasters the vector data of the NATURA2000 data onto all cutout regions
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    renewable:
+        {technology}:
+            cutout:
+
 Inputs
 ------
 

scripts/build_powerplants.py

@@ -5,6 +5,8 @@ Get conventional powerplants from `powerplantmatching`, assign to buses and crea
 Relevant Settings
 -----------------
 
+*None*
+
 Inputs
 ------
 

scripts/build_renewable_profiles.py

@@ -12,6 +12,31 @@ The script ``build_renewable_profiles.py`` calculates for each node several geog
 Relevant settings
 -----------------
 
+.. code:: yaml
+
+    snapshots:
+
+    atlite:
+        nprocesses:
+
+    renewable:
+        {technology}:
+            cutout:
+            corine:
+            grid_codes:
+            distance:
+            natura:
+            max_depth:
+            max_shore_distance:
+            min_shore_distance:
+            capacity_per_sqkm:
+            correction_factor:
+            potential:
+            min_p_max_pu:
+            clip_p_max_pu:
+            resource:
+
+
 config.renewable (describes the parameters for onwind, offwind-ac, offwind-dc
 and solar)
 config.snapshots (describes the time dimensions of the selection of snapshots)

scripts/build_shapes.py

@@ -4,6 +4,10 @@ Create GIS shape files for countries on-shore and off-shore, europe and nuts3 re
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    countries:
+
 Inputs
 ------
 

scripts/cluster_network.py

@@ -5,6 +5,19 @@ Create networks clustered to `cluster` number of zones with aggregated buses, ge
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    renewable: (keys)
+        {technology}:
+            potential:
+
+    solving:
+        solver:
+            name:
+
+    lines:
+        length_factor:
+
 Inputs
 ------
 
@@ -103,7 +116,7 @@ def plot_weighting(n, country, country_shape=None):
 
 def distribute_clusters(n, n_clusters, solver_name=None):
     if solver_name is None:
-        solver_name = snakemake.config['solver']['solver']['name']
+        solver_name = snakemake.config['solving']['solver']['name']
 
     L = (n.loads_t.p_set.mean()
          .groupby(n.loads.bus).sum()

scripts/make_summary.py

@@ -4,6 +4,17 @@ Create summaries of aggregated energy and costs as csv files
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    costs:
+        USD2013_to_EUR2013:
+        discountrate:
+        marginal_cost:
+        capital_cost:
+
+    electricity:
+        max_hours:
+
 Inputs
 ------
 

scripts/prepare_links_p_nom.py

@@ -5,6 +5,8 @@ Extract capacities for HVDC links from wikipedia
 Relevant Settings
 -----------------
 
+*None*
+
 Inputs
 ------
 

scripts/prepare_network.py

@@ -5,6 +5,19 @@ Prepare PyPSA network for solving according to `opts`-wildcard
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    costs:
+        emission_prices:
+        USD2013_to_EUR2013:
+        discountrate:
+        marginal_cost:
+        capital_cost:
+
+    electricity:
+        co2limit:
+        max_hours:
+
 Inputs
 ------
 

scripts/simplify_network.py

@@ -6,6 +6,31 @@ single link
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    costs:
+        USD2013_to_EUR2013:
+        discountrate:
+        marginal_cost:
+        capital_cost:
+
+    electricity:
+        max_hours:
+
+    renewables: (keys)
+        {technology}:
+            potential:
+
+    lines:
+        length_factor:
+
+    links:
+        p_max_pu:
+
+    solving:
+        solver:
+            name:
+
 Inputs
 ------
 

scripts/solve_network.py

@@ -4,6 +4,29 @@ Solve networks iteratively linear optimal power flow, while updating reactances
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    (electricity:)
+        (BAU_mincapacities:)
+        (SAFE_reservemargin:)
+
+    solving:
+        tmpdir:
+        options:
+            formulation:
+            clip_p_max_pu:
+            load_shedding:
+            noisy_costs:
+            nhours:
+            min_iterations:
+            max_iterations:
+        solver:
+            name:
+            {solveroptions}:
+
+    (plotting:)
+        (conv_techs:)
+
 Inputs
 ------
 

scripts/solve_operations_network.py

@@ -5,6 +5,22 @@ capacity expansion
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    solving:
+        tmpdir:
+        options:
+            formulation:
+            clip_p_max_pu:
+            load_shedding:
+            noisy_costs:
+            nhours:
+            min_iterations:
+            max_iterations:
+        solver:
+            name:
+            {solveroptions}:
+
 Inputs
 ------
 

scripts/trace_solve_network.py

@@ -5,6 +5,22 @@ records intermediate branch capacity steps and values of the objective
 Relevant Settings
 -----------------
 
+.. code:: yaml
+
+    solving:
+        tmpdir:
+        options:
+            formulation:
+            clip_p_max_pu:
+            load_shedding:
+            noisy_costs:
+            nhours:
+            min_iterations:
+            max_iterations:
+        solver:
+            name:
+            {solveroptions}:
+
 Inputs
 ------