add rule section headers

scripts/add_electricity.py

@@ -1,6 +1,19 @@
 # coding: utf-8
 """
 Adds electrical generators and storage units to base network
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import logging

scripts/base_network.py

@@ -1,6 +1,19 @@
 # coding: utf-8
 """
 Creates the network topology from ENTSO-E map extracts as a PyPSA network
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import yaml

scripts/build_bus_regions.py

@@ -1,5 +1,18 @@
 """
 Creates onshore and offshore Voronoi shapes for each bus
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import os

scripts/build_country_flh.py

@@ -1,6 +1,19 @@
 #!/usr/bin/env python
 """
 Create csv files and plots for comparing per country full load hours of renewable time-series
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import os

scripts/build_cutout.py

@@ -1,5 +1,18 @@
 """
 Create cutouts configured in `atlite` config section
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 import os
 import atlite

scripts/build_hydro_profile.py

@@ -2,8 +2,19 @@
 """
 Build hydroelectric inflow time-series for each country
 
-See also
+Relevant Settings
---------
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
+.. seealso::
     build_renewable_profiles
 """
 

scripts/build_natura_raster.py

@@ -1,5 +1,18 @@
 """
 Rasters the vector data of the NATURA2000 data onto all cutout regions
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import numpy as np

scripts/build_powerplants.py

@@ -1,6 +1,19 @@
 # coding: utf-8
 """
 Get conventional powerplants from `powerplantmatching`, assign to buses and create csv file
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import logging

scripts/build_renewable_profiles.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
 """
-Summary
--------
 The script ``build_renewable_profiles.py`` calculates for each node several geographical properties:
 
   1. the installable capacity (based on land-use)
@@ -47,7 +45,7 @@ for offshore we also have:
 underwater_fraction (bus) - the fraction of the average connection distance
 which is under water
 
-Long description:
+Description:
 -----------------
 
 First the script computes how much of the technology can be installed at each

scripts/build_shapes.py

@@ -1,5 +1,18 @@
 """
 Create GIS shape files for countries on-shore and off-shore, europe and nuts3 regions
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import os

scripts/cluster_network.py

@@ -2,9 +2,18 @@
 """
 Create networks clustered to `cluster` number of zones with aggregated buses, generators and transmission corridors
 
-Summary
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
 -------
 
+Description
+-----------
+
 The rule cluster_network instead clusters the network to a given number of buses.
 
     -Why is this cluster function used?

scripts/make_summary.py

@@ -1,5 +1,18 @@
 """
 Create summaries of aggregated energy and costs as csv files
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import os

scripts/plot_network.py

@@ -1,5 +1,18 @@
 """
 Plot map with pie charts and cost box plots
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 # Dirty work-around so that sphinx can import this module and get the

scripts/plot_p_nom_max.py

@@ -1,5 +1,18 @@
 """
 Plot renewable installation potentials per capacity factor
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import pypsa

scripts/plot_summary.py

@@ -1,5 +1,18 @@
 """
 Plot energy and cost summaries for several solved networks
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import os

scripts/prepare_links_p_nom.py

@@ -1,6 +1,19 @@
 #!/usr/bin/env python
 """
 Extract capacities for HVDC links from wikipedia
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import pandas as pd

scripts/prepare_network.py

@@ -1,6 +1,19 @@
 # coding: utf-8
 """
 Prepare PyPSA network for solving according to `opts`-wildcard
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import logging

scripts/simplify_network.py

@@ -3,6 +3,18 @@
 remove network dead-ends, and reduce multi-hop linear HVDC connections to a
 single link
 
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 The rule simplify_network does up to four things:
 
 1. Create an equivalent transmission network in which all voltage levels are mapped to the 380 kV level by the function ``simplify_network(...)``.

scripts/solve_network.py

@@ -1,5 +1,18 @@
 """
 Solve networks iteratively linear optimal power flow, while updating reactances
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import numpy as np

scripts/solve_operations_network.py

@@ -1,6 +1,19 @@
 """
 Solve linear optimal dispatch in hourly resolution with capacities of previous
 capacity expansion
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import pypsa

scripts/trace_solve_network.py

@@ -1,6 +1,19 @@
 """
 Iteratively solves expansion problem like solve_network, but additionally
 records intermediate branch capacity steps and values of the objective
+
+Relevant Settings
+-----------------
+
+Inputs
+------
+
+Outputs
+-------
+
+Description
+-----------
+
 """
 
 import numpy as np