Configuration

PyPSA-Earth imports the configuration options originally developed in PyPSA-Eur and here reported and adapted. The options here described are collected in a config.yaml file located in the root directory. Users should copy the provided default configuration (config.default.yaml) and amend their own modifications and assumptions in the user-specific configuration file (config.yaml); confer installation instructions at installation.

Credits to PyPSA-Eur developers for the initial drafting of the configuration documentation here reported

Top-level configuration

version: 0.8.0
tutorial: false

logging:
  level: INFO
  format: "%(levelname)s:%(name)s:%(message)s"

results_dir: results/
summary_dir: results/

foresight: overnight


countries: ["NG", "BJ"]
# Can be replaced by country ["NG", "BJ"], continent ["Africa"] or user-specific region, see more at https://pypsa-earth.readthedocs.io/en/latest/user-guide/configuration/#top-level-configuration

enable:
  retrieve_databundle: true #  Recommended 'true', for the first run. Otherwise data might be missing.
  retrieve_databundle_sector: true
  retrieve_cost_data: true # true: retrieves cost data from technology data and saves in resources/costs.csv, false: uses cost data in data/costs.csv
  retrieve_cutout: true
  download_osm_data: true # If 'true', OpenStreetMap data will be downloaded for the above given countries
  download_global_buildings: false # If 'true', GlobalMLBuildingFootprints data will be downloaded for the above given countries
  build_natura_raster: false # If 'true', then an exclusion raster will be build. Otherwise use pregenerated raster.
  build_cutout: false
  # If "build_cutout" : true, then environmental data is extracted according to `snapshots` date range and `countries`
  # requires cds API key https://cds.climate.copernicus.eu/how-to-api
  # More information https://atlite.readthedocs.io/en/latest/introduction.html#datasets
  progress_bar: true # show progress bar during downloading routines and other long-running tasks
  custom_busmap: false # if true, use "data/custom_busmap_elec_s{simpl}_{clusters}.csv" for the clustering instead of the clustering algorithms



custom_rules: [] # Default empty [] or link to custom rule file e.g. ["my_folder/my_rules.smk"] that add rules to Snakefile

Parameter	Unit	Values	Description
version	--	0.x.x	Version of PyPSA-Earth
tutorial	bool	{True, False}	Switch to retrieve the tutorial data set instead of the full data set.
logging	nan	nan	nan
-- level	--	Any of	Restrict console outputs to all infos, warning or errors only
-- format	--	nan	Custom format for log messages. See LogRecord attributes.
countries	--	Any two-letter country code on earth (60% are working, the team works on making it 100%), any continent, or any user-specific region	World countries defined by their Two-letter country codes (ISO 3166-1) which should be included in the energy system model.
enable	nan	nan	nan
-- retrieve_databundle	bool	{True, False}	Switch to retrieve databundle from zenodo via the rule :mod:retrieve_databundle_light or whether to keep a custom databundle located in the corresponding folder.
-- retrieve_cost_data	bool	{True, False}	True: retrieves cost data from technology data and saves in resources/costs.csv, false: uses cost data in data/costs.csv
-- download_osm_data	bool	{True, False}	True: OpenStreetMap data will be downloaded for the above given countries.
-- build_natura_raster	bool	{True, False}	Switch to enable the creation of the raster natura.tiff via the rule :mod:build_natura_raster.
-- retrieve_cutout	bool	{True, False}	Switch to retrieve cutout_databundle from gdrive via the rule :mod:retrieve_databundle_light.
-- build_cutout	bool	{True, False}	Switch to enable the building of cutouts via the rule :mod:build_cutout.
custom_rules	list	Empty in case no custom rules are needed [], otherwise e.g. ["my_folder/my_rules.smk"]	Enable the addition of custom rules to the Snakefile

run

It is common conduct to analyse energy system optimisation models for multiple scenarios for a variety of reasons, e.g. assessing their sensitivity towards changing the temporal and/or geographical resolution or investigating how investment changes as more ambitious greenhouse-gas emission reduction targets are applied.

The run section is used for running and storing scenarios with different configurations which are not covered by wildcards. It determines the path at which resources, networks and results are stored. Therefore the user can run different configurations within the same directory. If a run with a non-empty name should use cutouts shared across runs, set shared_cutouts to true.

run:
  name: "" # use this to keep track of runs with different settings
  sector_name: "" # use this to keep track of sector scenario runs
  shared_cutouts: true # set to true to share the default cutout(s) across runs
  # Note: value false requires build_cutout to be enabled
  allow_scenario_failure: false # If True, the workflow will continue even if a scenario in run_scnenario fails

Parameter	Unit	Values	Description
name	string	nan	Keeps track of runs with different settings.
shared_cutouts	bool	{True, False}	True: shares the default cutout(s) across runs. Note: value false requires build_cutout to be enabled.

scenario

The scenario section is an extraordinary section of the config file that is strongly connected to the wildcards and is designed to facilitate running multiple scenarios through a single command

snakemake -j 1 solve_all_networks

For each wildcard, a list of values is provided. The rule solve_all_networks will trigger the rules for creating results/networks/elec_s{simpl}_{clusters}_ec_l{ll}_{opts}.nc for all combinations of the provided wildcard values as defined by Python's itertools.product(...) function that snakemake's expand(...) function uses.

An exemplary dependency graph (starting from the simplification rules) then looks like this:

scenario:
  simpl: [""]
  ll: ["copt"]
  clusters: [10]
  opts: [Co2L-3h]
  planning_horizons: # investment years for myopic and perfect; or costs year for overnight
  - 2030
  sopts:
  - "144h"
  demand:
  - "AB"

Parameter	Unit	Values	Description
simpl	--	cf. :ref:simpl	List of {simpl} wildcards to run.
ll	--	cf. :ref:ll	List of {ll} wildcards to run.
clusters	--	cf. :ref:clusters	List of {clusters} wildcards to run.
opts	--	cf. :ref:opts	List of {opts} wildcards to run.

snapshots

Specifies the temporal range for the historical weather data, which is used to build the energy system model. It uses arguments to pandas.date_range. The date range must be in the past (before 2022). A well-tested year is 2013.

snapshots:
  start: "2013-01-01"
  end: "2014-01-01"
  inclusive: "left" # end is not inclusive

# definition of the Coordinate Reference Systems

Parameter	Unit	Values	Description
start	--	str or datetime-like; e.g. YYYY-MM-DD	Left bound of date range. Has to be in the past as weather and demand data for that year is required.
end	--	str or datetime-like; e.g. YYYY-MM-DD	Right bound of date range. Has to be in the past as weather and demand data for that year is required.
closed	--	One of	Make the time interval closed to the left, right, or both sides None.

crs

Defines the coordinate reference systems (crs).

crs:
  geo_crs: EPSG:4326 # general geographic projection, not used for metric measures. "EPSG:4326" is the standard used by OSM and google maps
  distance_crs: EPSG:3857 # projection for distance measurements only. Possible recommended values are "EPSG:3857" (used by OSM and Google Maps)
  area_crs: ESRI:54009 # projection for area measurements only. Possible recommended values are Global Mollweide "ESRI:54009"

Parameter	Unit	Values	Description
geo_crs	nan	"General geographic projection. Not used for metric measures."	"Recommended value is ‘EPSG:4326’ (used by OSM and Google Maps)."
distance_crs	nan	"Projection for distance measurements only."	"Recommended value is ‘EPSG:3857’ (used by OSM and Google Maps)."
area_crs	nan	"Projection for area measurements only."	"Recommended value is the Global Mollweide projection ‘ESRI:54009’."

augmented_line_connection

If enabled, it increases the connectivity of the network. It makes the network graph k-edge-connected, i.e., if fewer than k edges are removed, the network graph stays connected. It uses the k-edge-augmentation algorithm from the NetworkX Python package.

augmented_line_connection:
  add_to_snakefile: false # If True, includes this rule to the workflow
  connectivity_upgrade: 2 # Min. lines connection per node,
  # https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation.html#networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation
  new_line_type: ["HVAC"] # Expanded lines can be either ["HVAC"] or ["HVDC"] or both ["HVAC", "HVDC"]
  min_expansion: 1 # [MW] New created line expands by float/int input
  min_DC_length: 600 # [km] Minimum line length of DC line

Parameter	Unit	Values	Description
add_to_snakefile	bool	{True, False}	True: includes this rule to the workflow.
connectivity_upgrade	int	{1, 2, 3, ...}	Number k such that the network graph is k-edge-connected.
new_line_type	nan	{[HVAC], [HVDC], [HVAC, HVDC]}	Type of expanded lines.
min_expansion	int or float	nan	[MW] New created line capacity.
min_DC_length	int or float	nan	[km] Minimum line length of HVDC line.

cluster_options

Specifies the options to simplify and cluster the network. This is done in two stages, first using the rule simplify_network and then using the rule cluster_network. For more details on this process, see the PyPSA-Earth paper, section 3.7.

cluster_options:
  simplify_network:
    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
    algorithm: kmeans # choose from: [hac, kmeans]
    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
    exclude_carriers: []
    remove_stubs: true
    remove_stubs_across_borders: false
    p_threshold_drop_isolated: 20 # [MW] isolated (sub)networks or nodes are being discarded if total mean power is below the specified threshold
    p_threshold_merge_isolated: 300 # [MW] isolated (sub)networks or nodes are being merged into a single isolated bus if total mean power is below the specified threshold
    s_threshold_fetch_isolated: false # [-] a share of the national load for merging an isolated network into a backbone network
  cluster_network:
    algorithm: kmeans
    feature: solar+onwind-time
    exclude_carriers: []
  alternative_clustering: false # "False" use Voronoi shapes, "True" use GADM shapes
  distribute_cluster: ["load"] # Distributes cluster nodes per country according to ['load'],['pop'] or ['gdp']
  out_logging: true # When "True", logging is printed to console
  aggregation_strategies:
    generators: # use "min" for more conservative assumptions
      p_nom: sum
      p_nom_max: sum
      p_nom_min: sum
      p_min_pu: mean
      p_max_pu: weighted_average
      marginal_cost: mean
      committable: any
      ramp_limit_up: max
      ramp_limit_down: max
      efficiency: mean
      build_year: mean
      lifetime: mean
    one_ports: # storage units and loads
      StorageUnit:
        build_year: mean
        lifetime: mean
  focus_weights: false # When a value specified, set the share of nodes allocated to each country
    # country: share

Parameter	Unit	Values	Description
simplify_network	nan	nan	nan
-- to_substations	bool	{True, False}	False: network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections).
-- algorithm	nan	{hac, kmeans, modularity}	Clustering algorithm used in the simplify_network rule. Options available are Hierarchical Agglomerative Clustering (HAC), k-means, or greedy modularity.
-- feature	nan	Str in the format ‘carrier1+carrier2+...+carrierN-X’, where CarrierI can be from {‘solar’, ‘onwind’, ‘offwind’, ‘ror’} and X is one of {‘cap’, ‘time’}. Examples: solar+offwind-cap, solar-time	Only for Hierarchical Agglomerative Clustering (HAC). Feature(s) used to do the clustering.
-- exclude_carriers	nan	List of Str like [ 'solar', 'onwind'] or empy list []	Carriers not considered in the simplify_network rule. Can be any set of carriers (conventional or renewable).
-- remove_stubs	bool	{True, False}	True: Stub lines and links, i.e. dead-ends of the network, are sequentially removed from the network.
-- remove_stubs_across_borders	bool	{True, False}	True: Stub lines and links can be removed across borders.
-- p_threshold_drop_isolated	MW	positive number	Isolated buses are discarded if bus mean power is below the p_threshold_drop_isolated.
-- p_threshold_merge_isolated	MW	positive number	Isolated buses are merged into a single isolated bus if bus mean power is below p_threshold_merge_isolated.
-- s_threshold_fetch_isolated	[-]	positive number	Isolated networks are merged into a backbone network of a respective country if the network load comprises a share of the national load less than p_threshold_fetch_isolated.
cluster_network	nan	nan	nan
-- algorithm	nan	{hac, kmeans}	Clustering algorithm used in the cluster_network rule. Options available are Hierarchical Agglomerative Clustering (HAC) or k-means.
-- feature	nan	Str in the format ‘carrier1+carrier2+...+carrierN-X’, where CarrierI can be from {‘solar’, ‘onwind’, ‘offwind’, ‘ror’} and X is one of {‘cap’, ‘time’}. Examples: solar+offwind-cap, solar-time	Only for Hierarchical Agglomerative Clustering (HAC). Feature(s) used to do the clustering.
-- exclude_carriers	nan	List of Str like [ 'solar', 'onwind'] or empy list []	Carriers not considered in the cluster_network rule. Can be any set of carriers (conventional or renewable).
alternative_clustering	bool	{True, False}	False: use Voronoi shapes in the clustering. True: use GADM shapes in the clustering.
distribute_cluster	nan	{['load'], ['pop'], ['gdp']}	Distributes cluster nodes per country according to load (['load']), population (['pop']) or GDP (['gdp']).
out_logging	bool	{True, False}	True: Logging is printed to the console.
aggregation_strategies	nan	nan	nan
-- generators	nan	nan	nan
-- -- p_nom	nan	{min, mean, max, sum}	Indicates how the p_nom of the aggregated generator is computed from the original p_nom values. For example, if sum, then all values within each cluster are summed to represent the new generator.
-- -- p_nom_max	nan	{min, mean, max, sum}	Indicates how the p_nom_max of the aggregated generator is computed from the original p_nom_max values.
-- -- p_nom_min	nan	{min, mean, max, sum}	Indicates how the p_nom_min of the aggregated generator is computed from the original p_nom_min values.
-- -- p_min_pu	nan	{min, mean, max, sum}	Indicates how the p_min_pu of the aggregated generator is computed from the original p_min_pu values.
-- -- marginal_cost	nan	{min, mean, max, sum}	Indicates how the marginal_cost of the aggregated generator is computed from the original marginal_cost values.
-- -- commitable	nan	{any}	Indicates how the commit status of the aggregated generator is set depending on the original values of the generators. Unit Commitment is currently under development, so should be left to any.
-- -- ramp_limit_up	nan	{min, mean, max, sum}	Indicates how the ramp_limit_up of the aggregated generator is computed from the original ramp_limit_up values.
-- -- ramp_limit_down	nan	{min, mean, max, sum}	Indicates how the ramp_limit_down of the aggregated generator is computed from the original ramp_limit_down values.
-- -- efficiency	nan	{min, mean, max, sum}	Indicates how the efficiency of the aggregated generator is computed from the original efficiency values.
focus_weights	nan	Dict consisting of {country: share} such as {NG: 0.4}	When specified, set the share of nodes allocated to each country. The sum of focus weights must be less than or equal to 1.

build_shape_options

Specifies the options to build the shapes in which the region of interest (countries) is divided.

build_shape_options:
  gadm_layer_id: 1 # GADM level area used for the gadm_shapes. Codes are country-dependent but roughly: 0: country, 1: region/county-like, 2: municipality-like
  simplify_tolerance: 0.01 # Default value is 0.01, higher the value more is the simplification of the GADM shapes
  simplify_gadm: true # When true, shape polygons are simplified else no
  minarea: 0.01 # Minimum area of polygons to be retained in GADM shapes after simplification, in square degrees. Polygons with area smaller than this value will be removed
  update_file: false # When true, all the input files are downloaded again and replace the existing files
  out_logging: true # When true, logging is printed to console
  year: 2020 # reference year used to derive shapes, info on population and info on GDP
  nprocesses: 3 # number of processes to be used in build_shapes
  worldpop_method: "standard" # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster,
  # false (not "false") no pop addition to shape which is useful when generating only cutout
  gdp_method: "standard" # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout
  contended_flag: "set_by_country" # "set_by_country" assigns the contended areas to the countries according to the GADM database, "drop" drops these contended areas from the model

Parameter	Unit	Values	Description	Unnamed: 4	Unnamed: 5	Unnamed: 6	Unnamed: 7
gadm_layer_id	nan	"{0	1	2}"	"GADM level area used for the gadm_shapes. Codes are country-dependent but roughly: 0: country	1: region/county-like	2: municipality-like."
simplify_gadm	bool	{True, False}	True: shape polygons are simplified else no	nan	nan	nan	nan
simplify_tolerance	float	>= 0	Specifies tolerance limit when simplifying GADM shapes. A higher value indicates more simplification	nan	nan	nan	nan
minarea	float	>= 0	Minimum area of polygons to be retained after GADM simplification. If area is lower than minarea, then the shape is removed	nan	nan	nan	nan
update_file	bool	"{True	False}"	"True: all input files are downloaded again and replace the existing files."	nan	nan	nan
out_logging	bool	"{True	False}"	"True: Logging is printed in the console."	nan	nan	nan
year	nan	"past year; e.g. YYYY"	"Reference year used to derive shapes	info on population and info on GDP."	nan	nan	nan
nprocesses	int	nan	"Number of processes to be used in build_shapes."	nan	nan	nan	nan
worldpop_method	nan	"{"standard"	"api"	false}"	"Specifies how population is added to every shape: "standard" pulls from web 1kmx1km raster; "api" pulls from API 100mx100m raster; false (not "false") no population addition to shape. This is useful when generating only cutout."	nan	nan
gdp_method	nan	"{"standard"	false}"	"Specifies how GDP is added to every shape: "standard" pulls from web 1x1km raster; false (not "false") no gdp addition to shape. This is useful when generating only cutout."	nan	nan	nan
contended_flag	nan	"{"set_by_country"	"drop"}"	"Specifies what to do with contended countries: "set_by_country" assigns the contended areas to the countries according to the GADM database; "drop" drops the contended areas from the model."	nan	nan	nan

subregion

If enabled, this option allows a region of interest (countries) to be redefined into subregions, which can be activated at various stages of the workflow. Currently, it is used in simplify_network and cluster_network rule.

subregion:
  method: false # method to define subregions, either "gadm" or "custom", false to not use subregions.
  apply_on: ["simplify_network", "cluster_network"] # apply subregion on the simplify_network and/or cluster_network rule.
  define_by_gadm: false # name of the subregion. Multiple countries can be part in the same subregion.
  path_custom_shapes: false # provide the specific absolute path of the custom file e.g. (...\data\custom_shapes.geojson)
  path_custom_offshore: false # (optional) provide the specific absolute path of the custom offshore file e.g. (...\data\custom_offshore.geojson)
  tolerance: 100 # Buffer distance (in km) for assigning a country/subregion shape to a bus (the default tolerance is 100 km)

Parameter	Unit	Values	Description
method	nan	{gadm, custom , false}	"method to define subregions, either "gadm" or "custom", false to not use subregions".
apply_on	list	Any subset of	Enables subregion definitions in specific rules. simplify_network allows network simplification functions to drop or merge nodes based on subregions rather than just countries. cluster_network allows focus_weights to set clustering focus based on subregion names.
define_by_gadm	Str: list	{subregion_name}: [GADM IDs]	Used only when subregion: method: gadm. Specifies the names of subregions and its GADM IDs as a list
path_custom_shapes	-	path	Used only when subregion: method: custom. Specifies the subregion based on a custom shapes
path_custom_offshore	-	path	"(optional) Used only when subregion: method: custom. Specifies the offshore subregion based on a custom shapes. If not specified, offshore subregions are generated from the available subregion shapes."
tolerance	km	int	Buffer distance for assigning a country/subregion shape to a bus (the default tolerance is 100 km)

The names of subregions are arbitrary. Its sizes are determined by how many GADM IDs that are included in the list. A single country can be divided into multiple subregions, and a single subregion can include GADM IDs from multiple countries. If the same GADM ID appears in different subregions, the first subregion listed will take precedence over that region. The remaining GADM IDs that are not listed will be merged back to form the remaining parts of their respective countries. For example, consider the Central District of Botswana, which has a GADM ID of BW.3. To separate this district from the rest of the country, you can select:

See config.default.yaml for the full configuration.

There are several formats for GADM IDs depending on the version, so before using this feature, please review the resources/shapes/gadm_shape.geojson file which can be created using the command:

``bash snakemake -j 1 build_shapes

Note

The rule build_shapes currently use Version 4.1 for their GADM data. This may change in the future.

clean_osm_data_options

Specifies the options to clean the OpenStreetMap (OSM) data.

clean_osm_data_options: # osm = OpenStreetMap
  names_by_shapes: true # Set the country name based on the extended country shapes
  threshold_voltage: 51000 # [V] minimum voltage threshold to keep the asset (cable, line, generator, etc.) [V]
  tag_substation: "transmission" # Filters only substations with 'transmission' tag, ('distribution' also available)
  add_line_endings: true # When "True", then line endings are added to the dataset of the substations
  generator_name_method: OSM # Methodology to specify the name to the generator. Options: OSM (name as by OSM dataset), closest_city (name by the closest city)
  use_custom_lines: "OSM_only" # Use OSM (OSM_only), customized (custom_only), both data sets (add_custom) or none (none)
  path_custom_lines: false # If exists, provide the specific absolute path of the custom file e.g. (...\data\custom_lines.geojson)
  use_custom_substations: "OSM_only" # Use OSM (OSM_only), customized (custom_only), both data sets (add_custom) or none (none)
  path_custom_substations: false # If exists, provide the specific absolute path of the custom file e.g. (...\data\custom_substations.geojson)
  use_custom_cables: "OSM_only" # Use OSM (OSM_only), customized (custom_only), both data sets (add_custom) or none (none)
  path_custom_cables: false # If exists, provide the specific absolute path of the custom file e.g. (...\data\custom_cables.geojson)

Parameter	Unit	Values	Description
names_by_shapes	bool	{True, False}	True: the country name is set based on the extended country shapes.
threshold_voltage	V	nan	Assets below the voltage threshold will not be considered (cable, line, generator, etc.).
tag_substation	nan	{transmission, distribution}	Filters only substations with the corresponding tag (transmission or distribution).
add_line_endings	bool	{True, False}	True: line endings are added to the dataset of the substations.
generator_name_method	nan	{OSM, closest_city}	Methodology to specify the name of generators. From OpenStreetMap (OSM) or named after the closest city (closest_city).
use_custom_{lines/substations/cables}	nan	{OSM_only, custom_only, add_custom}, none	Method for selecting which type of data is used for lines/cables/substations in the clean_osm_data script. Use OSM (OSM_only), customized (custom_only), both data sets (add_custom) or none (none). "none" can be useful to estimate the substation datasets relying only on the ending locations of lines and cables, without using any substation data.
path_custom_{lines/substations/cables}	nan	str	Path to the custom data for lines/substations/cables. This is used if the method for selecting the type of data is set to "custom_only" or "add_custom". The custom data should be in the same format as the OSM data, with the same columns and units. The dataset may contain a column "under_construction": when the value is True, the asset is not available and as such it is represented with null capacity (using "num_parallel=0").

build_osm_network

Specifies the options to build the OpenStreetMap (OSM) network.

build_osm_network: # Options of the build_osm_network script; osm = OpenStreetMap
  group_close_buses: true # When "True", close buses are merged and guarantee the voltage matching among line endings
  group_tolerance_buses: 5000 # [m] (default 5000) Tolerance in meters of the close buses to merge
  split_overpassing_lines: true # When True, lines overpassing buses are splitted and connected to the bueses
  overpassing_lines_tolerance: 1 # [m] (default 1) Tolerance to identify lines overpassing buses
  force_ac: false # When true, it forces all components (lines and substation) to be AC-only. To be used if DC assets create problem.

Parameter	Unit	Values	Description
bool	"{True	False}"	"True: close buses are merged and guarantee the voltage matching among line endings."
m	nan	"Tolerance in meters of the close buses to merge."	nan
bool	"{True	False}"	"True: lines overpassing buses are splitted and connected to the buses."
m	nan	"Tolerance to identify lines overpassing buses."	nan
bool	"{True	False}"	"True: forces all components (lines and substation) to be AC-only. To be used if DC assets create problems."

base_network

Specifies the minimum voltage magnitude in the base network and the offshore substations.

base_network:
  min_voltage_substation_offshore: 51000 # [V] minimum voltage of the offshore substations
  min_voltage_rebase_voltage: 51000 # [V] minimum voltage in base network

# DemandCast and GEGIS are two available options
# DemandCast covers 2000-2024
# GEGIS dataset provides data for 2011, 2013, 2018
# Details and comparison are provided in
# https://github.com/pypsa-meets-earth/pypsa-earth/issues/1724

Parameter	Unit	Values	Description
min_voltage_substation_offshore	V	nan	"Minimum voltage magnitude in offshore substations."
min_voltage_rebase_voltage	V	nan	"Minimum voltage magnitude in base network."

load_options

Specifies the options to estimate future electricity demand (load). Different years might be considered for weather and the socioeconomic pathway (GDP and population growth), to enhance modelling capabilities.

load_options:
  source: "gegis" # "demcast" or "gegis"
  weather_year: 2013 # Weather year of the load profile
  prediction_year: 2030 # Valid only if "gegis" used as a source
  scale: 1 # scales all load time-series, i.e. 2 = doubles load

Parameter	Unit	Values	Description
ssp	--	string	Scenario considered for shared socio-economic pathway (GDP and population growth)
weather_year	--	YYYY (past year)	Year from which weather data is taken. Must be a year in the past
prediction_year	--	YYYY (can be in the future)	Year for which the load scenario is computed (GDP and population)
scale	--	float or dict	Scale for all the load time-series or specific countries if specified

The snapshots date range (snapshots\start - snapshots\end) must be in the weather_year.

co2_budget

If enabled, this option allows setting different CO₂ targets for each planning horizon year. Only supports foresights with planning horizon such as myopic.

co2_budget:
  enable: false
  override_co2opt: true
  co2base_value: co2limit # choose from: [co2limit, co2base, absolute, {float}]
  year:
    2020: 1.0
    2025: 0.85
    2030: 0.70
    2035: 0.55
    2040: 0.40
    2045: 0.25
    2050: 0.1

Parameter	Unit	Values	Description
enable	nan	{True, False}	Switch to select whether to activate this feature.
override_co2opts	nan	{True, False}	Switch to select whether to the new co2 limits can override existing previous co2 options.
co2base_value	:math:t_{CO_2-eq}/a	{"co2limit", "co2base", "absolute", float}	The total system annual carbon dioxide equivalent emissions. The value can be provided as is, refer to existing CO₂ values, or if 'absolute' is selected, be defined for each planning horizon
year	nan	Dictionary with planning horizons as keys	CO₂ budget as a fraction of co2base_value. If absolute is selected, then the total emission is set per planning horizons year

electricity

Specifies the options for the rule add_electricity. This includes options across several features, including but not limited to: voltage levels, electricity carriers available, renewable capacity estimation, CO2 emission limits, operational reserve, storage parameters. See the table below for more details.

electricity:
  base_voltage: 380.
  voltages: [132., 220., 300., 380., 500., 750.]
  co2limit: 7.75e+7 # European default, 0.05 * 3.1e9*0.5, needs to be adjusted for Africa
  co2base: 1.487e+9 # European default, adjustment to Africa necessary
  agg_p_nom_limits: # enables to set country-wise maximum and minimum generation capacities for generators (e.g. renewables, nuclear, and geothermal)
    file: data/agg_p_nom_minmax.csv # path to csv file containing country-wise generation capacity limits
    include_existing: false # false: only new built capacities are constrained; true: existing capacities are accounted in the constraints
  hvdc_as_lines: false # should HVDC lines be modeled as `Line` or as `Link` component?
  automatic_emission: false
  automatic_emission_base_year: 1990 # 1990 is taken as default. Any year from 1970 to 2018 can be selected.

  operational_reserve: # like https://genxproject.github.io/GenX.jl/stable/Model_Reference/core/#Operational-Reserves
    activate: false
    epsilon_load: 0.02 # share of total load
    epsilon_vres: 0.02 # share of total renewable supply
    contingency: 0 # fixed capacity in MW

  max_hours:
    battery: 6
    H2: 168

  extendable_carriers:
      # Note: For landlocked countries (e.g., Jordan, Austria, Switzerland), remove 'offwind-ac' and 'offwind-dc'
          # from the Generator list below, as these offshore wind technologies require coastline access.
    Generator: [solar, onwind, offwind-ac, offwind-dc, OCGT]
    StorageUnit: [] # battery, H2
    Store: [battery, H2]
    Link: [] # H2 pipeline

  powerplants_filter: (DateOut >= 2022 or DateOut != DateOut) and (DateIn <= 2023 or DateIn != DateIn)
  custom_powerplants: false #  "false" use only powerplantmatching (ppm) data, "merge" combines ppm and custom powerplants, "replace" use only custom powerplants

  conventional_carriers: [nuclear, oil, OCGT, CCGT, coal, lignite, geothermal, biomass]
  renewable_carriers: [solar, onwind, offwind-ac, offwind-dc, hydro]

  estimate_renewable_capacities:
    stats: "irena" # False, = greenfield expansion, 'irena' uses IRENA stats to add expansion limits
    year: 2023 # Reference year, available years for IRENA stats are 2000 to 2023
    p_nom_min: 1 # any float, scales the minimum expansion acquired from stats, i.e. 110% of <years>'s capacities => p_nom_min: 1.1
    p_nom_max: false # sets the expansion constraint, False to deactivate this option and use estimated renewable potentials determine by the workflow, float scales the p_nom_min factor accordingly
    technology_mapping:
      # Wind is the Fueltype in ppm.data.Capacity_stats, onwind, offwind-{ac,dc} the carrier in PyPSA-Earth
      Offshore: [offwind-ac, offwind-dc]
      Onshore: [onwind]
      PV: [solar]

Parameter	Unit	Values	Description
base_voltage	kV	float	Base voltage to which all lines are simplified/aggregated. Simplification preserves transmission capacities.
voltages	kV	A subset of 'standard' voltages considered to map OSM-extracted voltages into 'standard' linetypes.	nan
co2limit	:math:t_{CO_2-eq}/a	float	Cap on system total annual carbon dioxide equivalent emissions.
co2base	:math:t_{CO_2-eq}/a	float	Reference value of system total annual carbon dioxide equivalent emissions. Used only if relative emission reduction target is specified in {opts} wildcard.
automatic_emission	bool	{True, False}	True: Emissions are obtained from automatic emission extraction procedure. False: Emissions are obtained manually
automatic_emission_base_year	nan	integer	CO2 emissions of year 1990 from EDGAR category 1A1a (Public electricity and heat production).
agg_p_nom_limits	nan	nan	Configure per carrier generator capacity constraints limiting minimum and maximum values of the expanded capacity p_nom_opt for individual countries. Is enabled if 'CCL' is present in {opts} wildcard.
-- file	file	path	Reference to .csv file that specifies per carrier generator nominal capacity constraints for individual countries. Default is data/agg_p_nom_minmax.csv.
-- include_existing	bool	{True, False}	True: Existing capacities are considered in the CCL constraints. False: Existing capacities are not considered in the CCL constraints. Default is false.
hvdc_as_lines	bool	{True, False}	True: HVDC cables are modelled as PyPSA Line components. False: HVDC cables are modeled as PyPSA Link components.
operational_reserve	nan	nan	The total operational reserve requirements consist of three components: epsilon_load, epsilon_vres, contingency. See GenX for more details.
-- activate	bool	{True, False}	True: Operational reserve requirements are considered in the model.
-- epsilon_load	float	[0, 1]	Share of total load that is required for operational reserve.
-- epsilon_vres	float	[0, 1]	Share of total renewable supply that is required for operational reserve.
-- contingency	MW	nan	Operational reserve added as a contigency. For example, 5000 adds 5000 MW to the operational reserve requirements.
max_hours	nan	nan	nan
-- battery	hours	nan	Amount of time it takes to fully charge batteries from empty if done at maximum power rate. See PyPSA documentation. It is used in the rule add_extra_components.
-- H2	hours	nan	Amount of time it takes to fully charge hydrogen storage from empty if done at maximum power rate. See PyPSA documentation. It is used in the rule add_extra_components.
extendable_carriers	nan	nan	nan
-- Generator	--	Any subset of	Adds extendable OCGT and/or CCGT in nodes where gas power plants are located today without capacity limits. Note that solar, onwind, offwind-ac, offwind-dc are extendable by default according to their potentials. It is used in the add_electricity rule.
-- StorageUnit	--	Any subset of	Adds extendable storage units (battery and/or hydrogen) at every node/bus after clustering without capacity limits and with zero initial capacity. It is used in the add_extra_components rule.
-- Store	--	Any subset of	Adds extendable storage units (battery and/or hydrogen) at every node/bus after clustering without capacity limits and with zero initial capacity.
-- Link	--	Any subset of	Adds extendable links (H2 pipelines only) at every connection where there are lines or HVDC links without capacity limits and with zero initial capacity. Hydrogen pipelines require hydrogen storage to be modelled as Store.
powerplants_filter	--	use pandas.query strings here, e.g. Country not in ['Germany']	Filter query for the default powerplant database.
custom_powerplants	--	{false, merge, replace}	Adds custom powerplants from custom_powerplants.csv: false - use only powerplantmatching (ppm) data, merge - combines ppm and custom powerplants, replace - use only custom powerplants.
conventional_carriers	--	Any subset of	List of conventional power plants to include in the model from resources/powerplants.csv.
renewable_carriers	--	Any subset of	List of renewable power plants to include in the model from resources/powerplants.csv.
estimate_renewable_capacities	nan	nan	nan
-- stats	nan	{irena or False}	Defines which database to use, currently only irena is available. irena uses IRENA stats to add expansion limits. False enables greenfield expansion.
-- year	nan	Any year beetween 2000 and 2023	Reference year for renewable capacities. Available years for IRENA stats are from 2000 to 2023.
-- p_nom_min	nan	float	Scales the minimum expansion acquired from stats. For example, 110% of 's capacities is obtained with p_nom_min: 1.1.
-- p_nom_max	nan	float or False	sets the expansion constraint, False to deactivate this option and use estimated renewable potentials determine by the workflow, float scales the p_nom_min factor accordingly.
-- technology_mapping	nan	nan	Maps the technologies defined in ppm.data.Capacity_stats with the carriers in PyPSA-Earth.
-- -- Offshore	nan	{'offwind-ac', 'offwind-dc'}	nan
-- -- Onshore	nan	{'onwind'}	nan
-- -- PV	nan	{'solar'}	nan

Carriers in conventional_carriers must not also be in extendable_carriers.

lines

Specifies electricity line parameters.

lines:
  ac_types:
    132.: "243-AL1/39-ST1A 20.0"
    220.: "Al/St 240/40 2-bundle 220.0"
    300.: "Al/St 240/40 3-bundle 300.0"
    380.: "Al/St 240/40 4-bundle 380.0"
    500.: "Al/St 240/40 4-bundle 380.0"
    750.: "Al/St 560/50 4-bundle 750.0"
  dc_types:
    500.: "HVDC XLPE 1000"
  s_max_pu: 0.7
  s_nom_max: .inf
  s_nom_max_min: -.inf
  length_factor: 1.25
  under_construction: "zero" # 'zero': set capacity to zero, 'remove': remove, 'keep': with full capacity

Parameter	Unit	Values	Description
ac_types	--	Values should specify a line type in PyPSA for AC lines. Keys should specify the corresponding voltage level (e.g. 220., 300. and 380. kV)	Specifies line types to assume for the different voltage levels of the target region. Should normally handle voltage levels 220, 300, and 380 kV.
dc_types	--	Values should specify a line type in PyPSA for DC-lines. Keys should specify the corresponding voltage level (e.g. 220., 300. and 380. kV)	Specifies DC-line types.
s_max_pu	--	Value in [0.,1.]	Correction factor for line capacities (s_nom) to approximate :math:N-1 security and reserve capacity for reactive power flows
s_nom_max	MW	float	Global upper limit for the maximum capacity of each extendable line.
s_nom_max_min	MW	float	Global lower limit for the maximum capacity of each extendable line.
length_factor	--	float	Correction factor to account for the fact that buses are not connected by lines through air-line distance.
under_construction	--	One of	Specifies how to handle lines which are currently under construction.

links

Specifies Link parameters. Links are a fundamental component of PyPSA .

links:
  p_max_pu: 1.0
  p_nom_max: .inf
  p_nom_max_min: -.inf
  under_construction: "zero" # 'zero': set capacity to zero, 'remove': remove, 'keep': with full capacity

Parameter	Unit	Values	Description
p_max_pu	--	Value in [0.,1.]	Correction factor for link capacities p_nom.
p_nom_max	MW	float	Global upper limit for the maximum capacity of each extendable DC link.
p_nom_max_min	MW	float	Global lower limit for the maximum capacity of each extendable DC link.
under_construction	--	One of	Specifies how to handle lines which are currently under construction. 'zero': set capacity to zero; 'remove': remove completely, 'keep': keep with full capacity.

transformers

Specifies transformers parameters and types.

transformers:
  x: 0.1
  s_nom: 2000.
  type: ""

Parameter	Unit	Values	Description
x	p.u.	float	Series reactance (per unit, using s_nom as base power of the transformer. Overwritten if type is specified.
s_nom	MVA	float	Limit of apparent power which can pass through branch. Overwritten if type is specified.
type	--	A transformer type in PyPSA.	Specifies transformer types to assume for the transformers of the ENTSO-E grid extraction.

atlite

Define and specify the atlite.Cutout used for calculating renewable potentials and time-series. All options except for features are directly used as cutout parameters.

Parameter	Unit	Values	Description
nprocesses	--	int	Number of parallel processes in cutout preparation
cutouts	nan	nan	nan
--	--	Convention is to name cutouts like <region>-<year>-<source> (e.g. europe-2013-era5).	Name of the cutout netcdf file. The user may specify multiple cutouts under configuration atlite: cutouts:. Reference is used in configuration renewable: {technology}: cutout:. The cutout base may be used to automatically calculate temporal and spatial bounds of the network.
-- -- module	--	Subset of	Source of the reanalysis weather dataset (e.g. ERA5 or SARAH-2)
-- -- x	°	Float interval within [-180, 180]	Range of longitudes to download weather data for. If not defined, it defaults to the spatial bounds of all bus shapes.
-- -- y	°	Float interval within [-90, 90]	Range of latitudes to download weather data for. If not defined, it defaults to the spatial bounds of all bus shapes.
-- -- time	nan	Time interval within ['1979', '2018'] (with valid pandas date time strings)	Time span to download weather data for. If not defined, it defaults to the time interval spanned by the snapshots.
-- -- features	nan	String or list of strings with valid cutout features ('inlfux', 'wind').	When freshly building a cutout, retrieve data only for those features. If not defined, it defaults to all available features.

renewable

Specifies the options to obtain renewable potentials in every cutout. These are divided in five different renewable technologies: onshore wind (onwind), offshore wind with AC connection (offwind-ac), offshore wind with DC connection (offwind-dc), solar (solar), and hydropower (hydro).

onwind

  onwind:
    cutout: auto
    resource:
      method: wind
      turbine: Vestas_V112_3MW
    capacity_per_sqkm: 3 # conservative, ScholzPhd Tab 4.3.1: 10MW/km^2
    # correction_factor: 0.93
    copernicus:
      # Scholz, Y. (2012). Renewable energy based electricity supply at low costs:
      #  development of the REMix model and application for Europe. ( p.42 / p.28)
      # CLC grid codes:
      # 11X/12X - Various forest types
      # 20  - Shrubs
      # 30  - Herbaceus vegetation
      # 40  - Cropland
      # 50  - Urban
      # 60  - Bare / Sparse vegetation
      # 80  - Permanent water bodies
      # 100 - Moss and lichen
      # 200 - Open sea
      grid_codes: [20, 30, 40, 60, 100, 111, 112, 113, 114, 115, 116, 121, 122, 123, 124, 125, 126]
      distance: 1000
      distance_grid_codes: [50]
    natura: true
    potential: simple # or conservative
    clip_p_max_pu: 1.e-2
    extendable: true

Parameter	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'cutout-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
Must be 'wind'	A superordinate technology type.	nan	nan
One of turbine types included in atlite	Specifies the turbine type and its characteristic power curve.	nan	nan
float	Allowable density of wind turbine placement.	nan	nan
nan	nan	nan	nan
Any subset of the Copernicus Land Cover code list	Specifies areas based on CLC which generally eligible for AC-connected offshore wind turbine placement.	nan	nan
int	(Optional) Distance to reserve as uneligible area around 'distance_grid_codes' for the renewable technology.	nan	nan
(Optional with 'distance') Any subset of the Copernicus Land Cover code list	Specifies from which a distance of 'distance' metres is unavailable as a buffer area.	nan	nan
{true, false}	Switch to exclude Natura 2000 natural protection areas. Area is excluded if true.	nan	nan
One of	Method to compute the maximal installable potential for a node; confer :ref:renewableprofiles	nan	nan
float	To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no onwind generation, adds a zero-capacity onwind generator so that onwind is considered in the capacity expansion. It is done in the add_electricity rule.	nan	nan

offwind-ac

  offwind-ac:
    cutout: auto
    resource:
      method: wind
      turbine: NREL_ReferenceTurbine_5MW_offshore
    capacity_per_sqkm: 2
    # correction_factor: 0.8855
    # proxy for wake losses
    # from 10.1016/j.energy.2018.08.153
    # until done more rigorously in #153
    copernicus:
      grid_codes: [80, 200]
    natura: true
    max_depth: 50
    max_shore_distance: 30000
    potential: simple # or conservative
    clip_p_max_pu: 1.e-2
    extendable: true

Parameter	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'cutout-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
Must be 'wind'	A superordinate technology type.	nan	nan
One of turbine types included in atlite	Specifies the turbine type and its characteristic power curve.	nan	nan
float	Allowable density of wind turbine placement.	nan	nan
[0., 1.]	Wind correction factor to account for wake losses. It gets multiplied by the theoretical maximum in the cutout to account for wake losses.	nan	nan
nan	nan	nan	nan
Any subset of the Copernicus Land Cover code list	Specifies areas based on CLC which generally eligible for AC-connected offshore wind turbine placement.	nan	nan
{true, false}	Switch to exclude Natura 2000 natural protection areas. Area is excluded if true.	nan	nan
float	Maximum sea water depth at which wind turbines can be build. Maritime areas with deeper waters are excluded in the process of calculating the AC-connected offshore wind potential.	nan	nan
float	Maximum distance to the shore beyond which wind turbines with AC connections cannot be build. Such areas far away from shore are excluded in the process of calculating the AC-connected offshore wind potential.	nan	nan
One of	Method to compute the maximal installable potential for a node; confer :ref:renewableprofiles	nan	nan
float	To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no offwind-ac generation, adds a zero-capacity offwind-ac generator so that offwind-ac is considered for capacity expansion. It is done in the add_electricity rule.	nan	nan

offwind-dc

  offwind-dc:
    cutout: auto
    resource:
      method: wind
      turbine: NREL_ReferenceTurbine_5MW_offshore
    # ScholzPhd Tab 4.3.1: 10MW/km^2
    capacity_per_sqkm: 3
    # correction_factor: 0.8855
    # proxy for wake losses
    # from 10.1016/j.energy.2018.08.153
    # until done more rigorously in #153
    copernicus:
      grid_codes: [80, 200]
    natura: true
    max_depth: 50
    min_shore_distance: 30000
    potential: simple # or conservative
    clip_p_max_pu: 1.e-2
    extendable: true

Parameter	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'cutout-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
Must be 'wind'	A superordinate technology type.	nan	nan
One of turbine types included in atlite	Specifies the turbine type and its characteristic power curve.	nan	nan
float	Allowable density of wind turbine placement.	nan	nan
[0., 1.]	Wind correction factor to account for wake losses. It gets multiplied by the theoretical maximum in the cutout to account for wake losses.	nan	nan
nan	nan	nan	nan
Any subset of the Copernicus Land Cover code list	Specifies areas based on CLC which generally eligible for AC-connected offshore wind turbine placement.	nan	nan
{true, false}	Switch to exclude Natura 2000 natural protection areas. Area is excluded if true.	nan	nan
float	Maximum sea water depth at which wind turbines can be build. Maritime areas with deeper waters are excluded in the process of calculating the AC-connected offshore wind potential.	nan	nan
float	Minimum distance to the shore below which wind turbines cannot be build. Such areas close to the shore are excluded in the process of calculating the AC-connected offshore wind potential.	nan	nan
One of	Method to compute the maximal installable potential for a node; confer :ref:renewableprofiles	nan	nan
float	To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no offwind-dc generation, adds a zero-capacity offwind-dc generator so that offwind-dc is considered for capacity expansion. It is done in the add_electricity rule.	nan	nan

solar

  solar:
    cutout: auto
    resource:
      method: pv
      panel: CSi
      orientation: latitude_optimal # will lead into optimal design
      # slope: 0.  # slope: 0 represent a flat panel
      # azimuth: 180.  # azimuth: 180 south orientation
    capacity_per_sqkm: 4.6 # From 1.7 to 4.6 addresses issue #361
    # Determined by comparing uncorrected area-weighted full-load hours to those
    # published in Supplementary Data to
    # Pietzcker, Robert Carl, et al. "Using the sun to decarbonize the power
    # sector: The economic potential of photovoltaics and concentrating solar
    # power." Applied Energy 135 (2014): 704-720.
    correction_factor: 0.854337
    copernicus:
      grid_codes: [20, 30, 40, 50, 60, 90, 100]
    natura: true
    potential: simple # or conservative
    clip_p_max_pu: 1.e-2
    extendable: true

Parameter	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'cutout-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
Must be 'pv'	A superordinate technology type.	nan	nan
One of {'Csi', 'CdTe', 'KANENA'} as defined in atlite	Specifies the solar panel technology and its characteristic attributes.	nan	nan
use either {latitude_optimal} or options such {slope: 0, azimuth: 180}	nan	nan	nan
Atlite function which returns for every raster the optimal slope and azimuth	nan	nan	nan
Realistically any angle in [0., 90.]	Specifies the tilt angle (or slope) of the solar panel. A slope of zero corresponds to the face of the panel aiming directly overhead. A positive tilt angle steers the panel towards the equator.	nan	nan
Any angle in [0., 360.]	Specifies the azimuth orientation of the solar panel. South corresponds to 180.°.	nan	nan
float	Allowable density of solar panel placement. Value relates to socio-technical acceptable density.	nan	nan
float	A correction factor for the capacity factor (availability) time series.	nan	nan
nan	nan	nan	nan
Any subset of the Copernicus Land Cover code list	Specifies areas based on CLC which generally eligible for AC-connected offshore wind turbine placement.	nan	nan
{true, false}	Switch to exclude Natura 2000 natural protection areas. Area is excluded if true.	nan	nan
One of	Method to compute the maximal installable potential for a node; confer :ref:renewableprofiles	nan	nan
float	To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no solar generation, adds a zero-capacity solar generator so that solar is considered for capacity expansion. It is done in the add_electricity rule.	nan	nan

hydro

  hydro:
    cutout: auto
    hydrobasins_level: 6
    resource:
      method: hydro
      hydrobasins: data/hydrobasins/hybas_world.shp
      flowspeed: 1.0 # m/s
      # weight_with_height: false
      # show_progress: true
    carriers: [ror, PHS, hydro]
    PHS_max_hours: 6
    hydro_max_hours: "energy_capacity_totals_by_country" # not active
    hydro_max_hours_default: 6.0 # (optional, default 6) Default value of max_hours for hydro when NaN values are found
    clip_min_inflow: 1.0
    extendable: true
    normalization:
      method: irena # 'hydro_capacities' to rescale country hydro production by using hydro_capacities, 'eia' or 'irena' to rescale by eia or irena data, false for no rescaling
     # use the weather year for weather-dominated variations (installed capacity is changing slowly)
     # the technology-year for policy-determined changes (installed capacity is changing quickly)
      year: 2023 # (optional) year of statistics used to rescale the runoff time series. When not provided, the cutout weather year is used
    multiplier: 1.1 # multiplier applied after the normalization of the hydro production; default 1.0
    hydro_min_inflow_pu: 1.0 # [hour] A threshold of energy to power ratio to classify hydro powerplants as reservoirs in case type is missed

See config.default.yaml for the full configuration.

Unnamed: 0	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'europe-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
nan	Specifies the Atlite method to calculate renewable potential.	nan	nan
nan	Specifies the file location for hydrobasins. They are used to make the runoff calibration, defining a polygon to compute the available water surface using a surface integral.	nan	nan
nan	nan	nan	nan
Any subset of	Specifies the types of hydro power plants to build per-unit availability time series for. 'ror' stands for run-of-river plants, 'PHS' represents pumped-hydro storage, and 'hydro' stands for hydroelectric dams.	nan	nan
float	Maximum state of charge capacity of the pumped-hydro storage (PHS) in terms of hours at full output capacity p_nom. Cf. PyPSA documentation <https://pypsa.readthedocs.io/en/latest/components.html#storage-unit>_.	nan	nan
Any of	Maximum state of charge capacity of the pumped-hydro storage (PHS) in terms of hours at full output capacity p_nom or heuristically determined. Cf. PyPSA documentation <https://pypsa.readthedocs.io/en/latest/components.html#storage-unit>_.	nan	nan
float	(optional, default 6) Default value of max_hours for hydro plants with missing values	nan	nan
float	To avoid too small values in the inflow time series, values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no hydro generation, adds a zero-capacity hydro generator so that hydro is considered for capacity expansion. It is done in the add_electricity rule.	nan	nan
dict	When specified, it describes how to normalize hydro time series to adhere to national statistics	nan	nan
str	Data source used to rescale the hydro runoff; option 'hydro_capacities' to use the provided 'data/hydro_capacities.csv', 'eia' or 'irena' for using the eia or irena file	nan	nan
year	(optional) Specify the desired year to be used for normalization, the default value corresponds to the cutout weather year	nan	nan
float	Multiplier factor of the rescaling process (default 1.0)	nan	nan
float	Minimum energy-to-capacity ratio used to classify hydropower plants with missing technology information: values above this threshold are treated as reservoir plants, while smaller values are classified as run-of-river.	nan	nan

csp

  csp:
    cutout: auto
    resource:
      method: csp
      installation: SAM_solar_tower
    capacity_per_sqkm: 2.392 # From 1.7 to 4.6 addresses issue #361
    # Determined by comparing uncorrected area-weighted full-load hours to those
    # published in Supplementary Data to
    # Pietzcker, Robert Carl, et al. "Using the sun to decarbonize the power
    # sector: The economic potential of photovoltaics and concentrating solar
    # power." Applied Energy 135 (2014): 704-720.
    copernicus:
      grid_codes: [20, 30, 40, 60, 90]
      distancing_codes: [50]
      distance_to_codes: 3000
    natura: true
    potential: simple # or conservative
    clip_p_max_pu: 1.e-2
    extendable: true
    csp_model: advanced # simple or advanced

# TODO: Needs to be adjusted for Africa.
# Costs Configuration

See config.default.yaml for the full configuration.

Parameter	Unit	Values	Description
Should be a file name listed in the configuration atlite: cutouts: (e.g. 'cutout-2013-era5')	reference an existing folder in the directory cutouts	or set as auto which redirects to the cutout configuration atlite: default:. Source module must be ERA5.	Specifies the directory where the relevant weather data is stored.
nan	nan	nan	nan
Must be 'csp'	nan	nan	nan
Should be 'SAM_solar_tower' as defined in atlite	Specifies the csp technology and its characteristic attributes.	nan	nan
float	Allowable density of csp tower placement. Value relates to socio-technical acceptable density.	nan	nan
nan	nan	nan	nan
Any subset of the Copernicus Land Cover code list	Specifies areas based on CLC which generally eligible for csp tower placement.	nan	nan
int	(Optional) Distance to reserve as uneligible area around 'distance_grid_codes' for the renewable technology.	nan	nan
(Optional with 'distance') Any subset of the Copernicus Land Cover code list	Specifies from which a distance of 'distance' metres is unavailable as a buffer area.	nan	nan
{true, false}	Switch to exclude Natura 2000 natural protection areas. Area is excluded if true.	nan	nan
One of	Method to compute the maximal installable potential for a node; confer :ref:renewableprofiles	nan	nan
float	To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero.	nan	nan
{True, False}	True: In nodes where there is no csp generation, adds a zero-capacity csp generator so that csp is considered for capacity expansion. It is done in the add_electricity rule.	nan	nan
One of	Specifies the CSP model to be used. The advanced model attach stores and links to the csp buses while the simple has no stores and links.	nan	nan

costs

Specifies the cost assumptions of the technologies considered. Cost information is obtained from the config file and the file data/costs.csv, which can also be modified manually.

costs:
  year: 2030 # cost file selection, i.e. costs_2030.csv in this case; reference year for costs is always 2020
  technology_data_version: v0.13.2
  discountrate: [0.071] #, 0.086, 0.111]
  country_specific_data: "" # (optional) Reference to the desired technology-data directory for techno-economic input data; Only "" and "US" supported, for other values check the technology-data output directory
  # Only needed if "US" is selected as `country_specific_data`, otherwise ignore
  cost_scenario: "moderate" # only used if `country_specific_data: "US"`; can be "moderate", "advanced" or "conservative"
  financial_case: "market" # only used if `country_specific_data: "US"`; can be "market" or "r&d"
  # Management of output currencies and exchange rates
  output_currency: "EUR" # full list of supported currencies at https://github.com/alexprengere/currencyconverter/blob/master/currency_converter/eurofxref.csv
  default_exchange_rate: 0.7532 # previously USD2013_to_EUR2013; should be sufficient as current data from 'technology-data` are either in EUR or USD; [EUR/USD] ECB: https://www.ecb.europa.eu/stats/exchange/eurofxref/html/eurofxref-graph-usd.en.html
  future_exchange_rate_strategy: "reference" # reference uses the exchange rate from `reference_year` for all conversions, ensuring all costs are expressed in the same currency and year; "latest" uses the yearly average of the latest available exchange rates for the selected `output_currency`; "custom" allows to specify a `custom_future_exchange_rate` below
  custom_future_exchange_rate: None # if `future_exchange_rate_strategy: "custom"`, please insert here the desired output_currency-to-EUR exchange rate
  rooftop_share: 0.14 # based on the potentials, assuming (0.1 kW/m2 and 10 m2/person)
  fill_values:
    FOM: 0
    VOM: 0
    efficiency: 1
    fuel: 0
    investment: 0
    lifetime: 25
    CO2 intensity: 0
    discount rate: 0.07
  marginal_cost: # EUR/MWh
    solar: 0.01
    onwind: 0.015
    offwind: 0.015
    hydro: 0.
    H2: 0.
    electrolysis: 0.
    fuel cell: 0.
    battery: 0.
    battery inverter: 0.
  emission_prices: # in currency per tonne emission, only used with the option Ep
    co2: 0.
  # investment: # EUR/MW
  #   CCGT: 830000
  # FOM: # %/year
  #   CCGT: 3.35
  # VOM: # EUR/MWh
  #   CCGT: 4.2
  # fuel: # EUR/MWh
  #   gas: 10.1
  # lifetime: # years
  #   CCGT: 25.0
  # efficiency: # per unit
  #   CCGT: 0.58
  lines:
    length_factor: 1.25 #to estimate offwind connection costs

Parameter	Unit	Values	Description
year	--	YYYY (e.g. 2030)	Year for which to retrieve cost assumptions for resources/costs.csv
technology_data_version	--	vX.X.X (e.g. v0.1.0)	Version of technology-data repository to use
discountrate	--	float	Rate of return used to discount future cash flows back to their present value
country_specific_data	bool	{True, False}	Reference to the desired technology-data directory for techno-economic input data
cost_scenario	--	{moderate, advanced, conservative}	Only used if country_specific_data is set to select the desired NREL financial case
financial_case	--	{market, r&d}	Only used if country_specific_data is set to select the desired NREL financial case
output_currency	--	{EUR, USD, JPY, CAD, CNY}	Reference currency for all costs (EUR is the base unit for conversion)
default_exchange_rate	--	float	Default US Dollar-Euro exchange rate
future_exchange_rate_strategy	--	{reference, latest, custom}	Strategy for currency conversion
custom_future_exchange_rate	--	{None, float}	Customized exchange rate if future_exchange_rate_strategy is custom
rooftop_share	--	float	Share of rooftop PV when calculating capital cost of solar
fill_values	--	dict	Default values if not specified for a technology in resources/costs.csv
marginal_cost	EUR/MWh	dict	Marginal operating costs for specified technologies
-- FOM	%/year	dict	Fixed Operations and Maintenance assumptions
-- VOM	EUR/MWh	dict	Variable Operations and Maintenance assumptions
-- efficiency	--	dict	Efficiency assumptions per technology
-- fuel	EUR/MWh	dict	Fuel price assumptions
-- investment	EUR/MW	dict	Investment cost assumptions
-- lifetime	years	dict	Technology lifetime assumptions
-- CO2 intensity	t_CO2/MWh	dict	CO2 intensity per technology
-- discount rate	--	dict	Discount rate per technology
emission_prices	--	dict	Exogenous prices for emission types
-- co2	EUR/t	float	Exogenous price of carbon-dioxide added to marginal costs

Note

To change cost assumptions in more detail (i.e. other than marginal_cost), consider modifying cost assumptions directly in data/costs.csv as this is not yet supported through the config file. You can also build multiple different cost databases. Make a renamed copy of data/costs.csv (e.g. data/costs-optimistic.csv) and set the variable COSTS=data/costs-optimistic.csv in the Snakefile.

The marginal costs or in this context variable costs of operating the assets is important for realistic operational model outputs. It can define the curtailment order of renewable generators, the dispatch order of generators, and the dispatch of storage units. If not appropriately set, the model might output unrealistic results. Learn more about this in Parzen et al. 2023 and in Kittel et al. 2022.

monte_carlo

Specifies the options for Monte Carlo sampling.

monte_carlo:
  # Description: Specify Monte Carlo sampling options for uncertainty analysis.
  # Define the option list for Monte Carlo sampling.
  # Make sure add_to_snakefile is set to true to enable Monte-Carlo
  options:
    add_to_snakefile: false # When set to true, enables Monte Carlo sampling
    samples: 9 # number of optimizations. Note that number of samples when using scipy has to be the square of a prime number
    sampling_strategy: "chaospy" # "pydoe2", "chaospy", "scipy", packages that are supported
    seed: 42 # set seedling for reproducibilty
  # Uncertanties on any PyPSA object are specified by declaring the specific PyPSA object under the key 'uncertainties'.
  # For each PyPSA object, the 'type' and 'args' keys represent the type of distribution and its argument, respectively.
  # Supported distributions types are uniform, normal, lognormal, triangle, beta and gamma.
  # The arguments of the distribution are passed using the key 'args'  as follows, tailored by distribution type
  # normal: [mean, std], lognormal: [mean, std], uniform: [lower_bound, upper_bound],
  # triangle: [mid_point (between 0 - 1)], beta: [alpha, beta], gamma: [shape, scale]
  # More info on the distributions are documented in the Chaospy reference guide...
  # https://chaospy.readthedocs.io/en/master/reference/distribution/index.html
  # An abstract example is as follows:
  # {pypsa network object, e.g. "loads_t.p_set"}:
  # type: {any supported distribution among the previous: "uniform", "normal", ...}
  # args: {arguments passed as a list depending on the distribution, see the above and more at https://pypsa.readthedocs.io/}
  uncertainties:
    loads_t.p_set:
      type: uniform
      args: [0.5, 1]
    generators_t.p_max_pu.loc[:, n.generators.carrier == "onwind"]:
      type: lognormal
      args: [1.5]
    generators_t.p_max_pu.loc[:, n.generators.carrier == "solar"]:
      type: beta
      args: [0.5, 2]

# ------------------- SECTOR OPTIONS -------------------

Parameter	Unit	Values	Description
options	nan	nan	nan
add_to_snakemake	nan	true or false	Set to true to enable Monte-Carlo
samples	nan	int	Defines the number of total sample networks that will be optimized. If the chosen sampling strategy is scipy, then a square of a prime number needs to be chosen. E.g. 49 which is (7^2)
sampling_strategy	nan	Any subset of	Current supported packages to create an experimental design
seed	nan	int	Allows experimentation to be reproduced easily
uncertainties	nan	nan	nan
	MW/MWh	nan	Key is a dynamic PyPSA object that allows to access any pypsa object such as loads_t.p_set or the max. wind generation per hour generators_t.p_max_pu.loc[:, n.generators.carrier == "wind"]. Values or bounds are multiplication for each object.
type	nan	str	Defines the distribution for the chosen pypsa.object parameter. Distribution can be either uniform, normal, lognormal, triangle, beta or gamma
args	nan	list	Defines parameters for the chosen distribution. [mean, std] for normal and lognormal, [lower_bound, upper_bound] for uniform, [mid_point (between 0 - 1)] for triangle, [alpha, beta] for beta, [shape, scale] for gamma

policy_config

Specifies the options regarding energy policy, for example in relation to hydrogen exports.

policy_config:
  hydrogen:
    temporal_matching: "no_temporal_matching" #either "hour", "month", "year", "no_temporal_matching"
    spatial_matching: false
    temporal_matching_carriers: [csp, solar, onwind, offwind-ac, offwind-dc, ror, hydro]
    matching_technologies: ["H2 Electrolysis", "Alkaline electrolyzer large", "Alkaline electrolyzer medium", "Alkaline electrolyzer small", "PEM electrolyzer", "SOEC"]
    additionality: false # RE electricity is equal to the amount required for additional hydrogen export compared to the 0 export case ("reference_case")
    allowed_excess: 1.0
    is_reference: false # Whether or not this network is a reference case network, relevant only if additionality is _true_
    remove_h2_load: false #Whether or not to remove the h2 load from the network, relevant only if is_reference is _true_
    path_to_ref: "" # Path to the reference case network for additionality calculation, relevant only if additionality is _true_ and is_reference is _false_
    re_country_load: false # Set to "True" to force the RE electricity to be equal to the electricity required for hydrogen export and the country electricity load. "False" excludes the country electricity load from the constraint.

Parameter	Unit	Values	Description
hydrogen
-- temporal_matching	--	One of	Specifies the temporal matching method for hydrogen production.
-- spatial_matching	bool	{true, false}	Indicates whether spatial matching is applied for hydrogen production. Currently, only 'false' is supported.
-- temporal_matching_carriers	--	Any subset of	Defines a list of renewable energy carriers considered for temporal matching of hydrogen production.
-- matching_technologies	--	Any subset of	Defines a list of hydrogen production technologies considered for matching.
-- additionality	bool	{true, false}	If true, ensures renewable electricity is equal to the amount required for additional hydrogen export compared to the reference case without hydrogen export. Currently, only 'false' is supported.
-- allowed_excess	p.u.	float	Defines the allowable excess renewable energy for hydrogen production.
-- is_reference	bool	{true, false}	Indicates whether the network is a reference case for additionality calculations. It is relevant only if additionality is true.
-- remove_h2_load	bool	{true, false}	Specifies whether to remove hydrogen load from the network in the reference case. It is relevant only if is_reference is true.
-- path_to_ref	--	string	Path to the reference case network for additionality calculation. It is relevant only if additionality is true and is_reference is false.
-- re_country_load	bool	{true, false}	If true, forces renewable electricity to match hydrogen export and country electricity load. If false, renewable electricity is only matched to hydrogen export. Currently, only 'false' is supported.

demand_data

Specifies sector-coupled related demand.

demand_data:
  update_data: true # if true, the workflow downloads the energy balances data saved in data/demand/unsd/data again. Turn on for the first run.
  base_year: 2019

  other_industries: false # Whether or not to include industries that are not specified. some countries have has exaggerated numbers, check carefully.
  aluminium_year: 2019 # Year of the aluminium demand data specified in `data/AL_production.csv`

Parameter	Unit	Values	Description
demand_data
update_data	bool	{true, false}	If true, the workflow downloads the energy balances data saved in data/demand/unsd/data again.
base_year	int	Any year (e.g. 2019)	Specifies the base year for energy balances data. Default year is 2019. If interested in a different year, please check presense of data for selected base year and country in data/demand/unsd/data.
other_industries	bool	{true, false}	Determines whether to include unspecified industries. Note that some countries may have inflated numbers; review cautiously.
aluminium_year	int	Any year between 2015 and 2022	Year of the aluminium production data specified in data/AL_production.csv. Default year is 2019.
fossil_reserves
oil	TWh	float	Specifies the total oil reserves in TWh per each bus.

export

Specifies the option related to hydrogen exports.

export:
  endogenous: false # If true, the export demand is endogenously determined by the model
  endogenous_price: 400 # EUR/MWh # Market price, for which the hydrogen for endogenous exports is sold. Only considered, if ["export"]["endogenous"] is set to true.
  store: true # [True, False] # specifies whether an export store to balance demand is implemented
  store_capital_costs: "no_costs" # ["standard_costs", "no_costs"] # specifies the costs of the export store. "standard_costs" takes CAPEX of "hydrogen storage tank type 1 including compressor"
  h2export: [10] # Yearly export demand in TWh. Only considered, if ["export"]["endogenous"] is set to false
  export_profile: "ship" # use "ship" or "constant". Only considered, if ["export"]["endogenous"] is set to false
  ship:
    ship_capacity: 0.4 # TWh # 0.05 TWh for new ones, 0.003 TWh for Susio Frontier, 0.4 TWh according to Hampp2021: "Corresponds to 11360 t H2 (l) with LHV of 33.3333 Mwh/t_H2. Cihlar et al 2020 based on IEA 2019, Table 3-B"
    travel_time: 288 # hours # From Agadir to Rotterdam and back (12*24)
    fill_time: 24 # hours, for 48h see Hampp2021
    unload_time: 24 # hours for 48h see Hampp2021

Parameter	Unit	Values	Description
endogenous	bool	{true, false}	If true, the export demand is endogenously determined by the model. Default is 'false'.
endogenous_price	EUR/MWh	float	Market price at which hydrogen for endogenous exports is sold. Only considered if endogenous is true.
store	bool	{true, false}	Indicates whether an export store is implemented to balance hydrogen export demand. Default is 'true'.
store_capital_costs	--	One of	Specifies the costs of the export store. 'standard_costs' uses CAPEX of 'hydrogen storage tank type 1 including compressor'. 'no_costs' assumes zero costs for the export store. Only considered if store is true.
h2export	TWh	float	Specifies the yearly hydrogen export demand in TWh. This parameter is only applicable if endogenous is set to false.
export_profile	--	One of	Specifies the export profile. Only considered if endogenous is false.
ship	nan	nan	Specifies parameters for hydrogen export via shipping.
ship_capacity	TWh	float	Specifies the ship capacity for hydrogen export. Example values: 0.05 TWh for new ships, 0.003 TWh for Susio Frontier, and 0.4 TWh based on Hampp 2021 (this corresponds to 11,360 t of liquid hydrogen (LHV of 33.3333 MWh/t_H2)).
travel_time	hours	int	Travel time for hydrogen export shipping (e.g. from Agadir to Rotterdam and back takes 288 hours).
fill_time	hours	int	Time required to fill the ship for hydrogen export. 48 hours is needed to fill the ship (see Hampp 2021).
unload_time	hours	int	Time required to unload the ship for hydrogen export. 48 hours is needed to unload the ship (see Hampp 2021).

custom_data

Specifies which custom datasets are used to replace or supplement the default model data. For full details see Custom Data Integration.

custom_data:
  heat_demand: false
  industry_demand: false
  industry_database: false
  transport_demand: false
  water_costs: false
  h2_underground: false
  add_existing: false
  custom_sectors: false
  gas_network: false # If "True" then a custom .csv file must be placed in "resources/custom_data/pipelines.csv"
  export_ports: false # If "True" then a custom .csv file must be placed in "data/custom/export_ports.csv"
  airports: false # If "True" then a custom .csv file must be placed in "data/custom/airports.csv"

Parameter	Unit	Values	Description
renewables	--	list of	List of renewable technologies for which custom time series data is used. Leave empty [] to use default data.
elec_demand	bool	{true, false}	If true, custom electricity demand data is used instead of the built-in dataset.
heat_demand	bool	{true, false}	If true, custom heat demand data is used instead of the built-in dataset.
industry_demand	bool	{true, false}	If true, custom industry demand data is used instead of the built-in dataset.
industry_database	bool	{true, false}	If true, a custom industry database is used instead of the built-in dataset.
transport_demand	bool	{true, false}	If true, custom transport demand data is used instead of the built-in dataset.
water_costs	bool	{true, false}	If true, custom water cost data is used instead of the built-in dataset.
h2_underground	bool	{true, false}	If true, custom hydrogen underground storage data is used instead of the built-in dataset.
add_existing	bool	{true, false}	If true, existing capacities are added from custom data.
custom_sectors	bool	{true, false}	If true, custom sector data is used.
gas_network	bool	{true, false}	If true, a custom gas network CSV must be placed at resources/custom_data/pipelines.csv. If false, the user can choose between greenfield or model built-in datasets.
export_ports	bool	{true, false}	If true, a custom export ports CSV must be placed at data/custom/export_ports.csv.
airports	bool	{true, false}	If true, a custom airports CSV must be placed at data/custom/airports.csv. Data format must match the airports.csv file in the data folder.

sector

Specifies the options for the sector coupling, i.e. the integration of the electricity system with other sectors such as heating and transport.

top-level

sector:
  enable:
    heat: true
    biomass: true
    industry: true
    shipping: true
    aviation: true
    land_transport: true
    rail_transport: true
    agriculture: true
    residential: true
    services: true

  gas:
    spatial_gas: true # ALWAYS TRUE
    network: false # ALWAYS FALSE for now (NOT USED)
    network_data: GGIT # Global dataset -> 'GGIT' , European dataset -> 'IGGIELGN'
    network_data_GGIT_status: ["Construction", "Operating", "Idle", "Shelved", "Mothballed", "Proposed"]

  hydrogen:
    network: true
    H2_retrofit_capacity_per_CH4: 0.6
    network_limit: 2000 #GWkm
    network_routes: gas # "gas or "greenfield". If "gas"  ->  the network data are fetched from ["sector"]["gas"]["network_data"]. If "greenfield"  -> the network follows the topology of electrical transmission lines
    gas_network_repurposing: true # If true -> ["sector"]["gas"]["network"] is automatically false
    underground_storage: false
    hydrogen_colors: false
    set_color_shares: false
    blue_share: 0.40
    pink_share: 0.05
    production_technologies: ["H2 Electrolysis", "SMR", "SMR CC"] # ["Alkaline electrolyzer large", "Alkaline electrolyzer medium", "Alkaline electrolyzer small", "PEM electrolyzer", "SOEC", "Solid biomass steam reforming", "Biomass gasification", "Biomass gasification CC", "Natural gas steam reforming", "Natural gas steam reforming CC", "Coal gasification", "Coal gasification CC", "Heavy oil partial oxidation"] a list of H2 production technologies that can be added

  coal:
    spatial_coal: true
    shift_to_elec: true # If true, residential and services demand of coal is shifted to electricity. If false, the final energy demand of coal is disregarded

  lignite:
    spatial_lignite: false

  oil:
    spatial_oil: true

Parameter	Unit	Values	Description
enable			Configuration for sector settings.
-- heat	bool	{true, false}	Flag to include heating sector.
-- biomass	bool	{true, false}	Flag to include biomass sector.
-- industry	bool	{true, false}	Flag to include industry sector.
-- shipping	bool	{true, false}	Flag to include shipping sector.
-- aviation	bool	{true, false}	Flag to include aviation sector.
-- land_transport	bool	{true, false}	Flag to include land transport sector.
-- rail_transport	bool	{true, false}	Flag to include rail transport sector.
-- agriculture	bool	{true, false}	Flag to include agriculture sector.
-- residential	bool	{true, false}	Flag to include residential sector.
-- services	bool	{true, false}	Flag to include service sector.
gas			Configuration for sector.gas settings.
-- spatial_gas	bool	{true, false}	Add option to spatially resolve carrier representing gas (methane) supply.
-- network	bool	{true, false}	Currently not available for gas carriers.
-- network_data	--	One of	Specify which existing gas pipeline to use. Either from Global Gas Infrastructure Tracker (GGIT) or European Gas Infrastructure (IGGIELGN)
-- network_data_GGIT_status	--	Any subset of	List of status to be included when retrieving gas infrastructure data.
hydrogen			Configuration for sector.hydrogen settings.
-- network	bool	{true, false}	Add option for new hydrogen pipelines.
-- H2_retrofit_capacity_per_CH4	MW/CH4	nan	Hydrogen transport capacity compared to natural gas capacity in retrofitted pipelines.
-- network_limit	GWkm	nan	Add maximum hydrogen network capacity.
-- network_routes	--	One of	Specify if either hydrogen network follows the topology of gas networks (gas) or closely resembles electrical transmission lines (greenfield).
-- gas_network_repurposing	bool	{true, false}	Specify if gas networks can be repurposed for hydrogen networks.
-- underground_storage	bool	{true, false}	Add options for storing hydrogen underground. Storage potential depends regionally.
-- hydrogen_colors	bool	{true, false}	Specify if hydrogen carriers are disaggregated based on their source.
-- set_color_shares	bool	{true, false}	Add option if hydogen sources must be derived from specific sources.
-- blue_share	float	[0, 1]	Share of hydrogen derived from gas with carbon capture.
-- pink_share	float	[0, 1]	Share of hydrogen derived from nuclear.
-- production_technologies	--	Any subset of	List of hydrogen production technologies that can be added.
coal			Configuration for sector.coal settings.
-- spatial_coal	bool	{true, false}	Add option to spatially resolve carrier representing coal supply.
-- shift_to_elec	bool	{true, false}	Specify if sectoral coal consumption can be electrified.
lignite			Configuration for sector.lignite settings.
-- spatial_lignite	bool	{true, false}	Add option to spatially resolve carrier representing lignite supply.
oil			Configuration for sector.oil settings.
-- spatial_oil	bool	{true, false}	Add option to spatially resolve carrier representing oil supply.

heat sector

  # ------------------- HEAT SECTOR -------------------

  district_heating:
    potential: 0.3 #maximum fraction of urban demand which can be supplied by district heating
    #increase of today's district heating demand to potential maximum district heating share
    #progress = 0 means today's district heating share, progress=-1 means maximum fraction of urban demand is supplied by district heating
    progress: 1
    # 2020: 0.0
    # 2030: 0.3
    # 2040: 0.6
    # 2050: 1.0
    district_heating_loss: 0.15
  reduce_space_heat_exogenously: false # reduces space heat demand by a given factor (applied before losses in DH)
  # this can represent e.g. building renovation, building demolition, or if
  # the factor is negative: increasing floor area, increased thermal comfort, population growth
  # NB The value of space heat reduction are Europe-specific
  # if they usage is enabled (reduce_space_heat_exogenously) a regional adjustment is needed
  reduce_space_heat_exogenously_factor: 0.29 # per unit reduction in space heat demand
  # the default factors are determined by the LTS scenario from http://tool.european-calculator.eu/app/buildings/building-types-area/?levers=1ddd4444421213bdbbbddd44444ffffff11f411111221111211l212221
  # 2020: 0.10  # this results in a space heat demand reduction of 10%
  # 2025: 0.09  # first heat demand increases compared to 2020 because of larger floor area per capita
  # 2030: 0.09
  # 2035: 0.11
  # 2040: 0.16
  # 2045: 0.21
  # 2050: 0.29
  space_heat_share: 0.6 # the share of space heating from all heating. Remainder goes to water heating.

  tes: true
  tes_tau: # 180 day time constant for centralised, 3 day for decentralised
    decentral: 3
    central: 180
  boilers: true
  oil_boilers: false
  chp: true
  micro_chp: false
  solar_thermal: true
  heat_pump_sink_T: 55 #Celsius, based on DTU / large area radiators; used un build_cop_profiles.py
  time_dep_hp_cop: true #time dependent heat pump coefficient of performance
  solar_cf_correction: 0.788457 # = >>>1/1.2683

Parameter	Unit	Values	Description
district_heating
-- potential	float	[0, 1]	Maximum fraction of urban demand which can be supplied by district heating
-- progress	float/dict	[0, 1] or {planning_horizons}: [0, 1]	Increase of today's district heating demand to potential maximum district heating share. Progress = 0 means today's district heating share. Progress = 1 means maximum fraction of urban demand is supplied by district heating.
-- district_heating_loss	float	[0, 1]	Share increase in district heat demand in urban central due to heat losses.
reduce_space_heat_exogenously	bool	{true, false}	Influence on space heating demand by a certain factor (applied before losses in district heating).
reduce_space_heat_exogenously_factor	float/dict	[0, 1] or {planning_horizons}: [0, 1]	A positive factor can mean renovation or demolition of a building. If the factor is negative, it can mean an increase in floor area, increased thermal comfort, population growth. The default factors are determined by the Eurocalc Homes and buildings decarbonization scenario <http://tool.european-calculator.eu/app/buildings/building-types-area/?levers=1ddd4444421213bdbbbddd44444ffffff11f411111221111211l212221>_.
space_heat_share	float	[0, 1]	Share of space heating from all heating. Remainder goes to water heating
tes	bool	{true, false}	Add option for storing thermal energy in large water pits associated with district heating systems and individual thermal energy storage (TES).
tes_tau
-- decentral	days	nan	The duration of a decentralized TES thermal energy is depleted due to standing losses.
-- central	days	nan	The duration of a centralized TES thermal energy is depleted due to standing losses.
boilers	bool	{true, false}	Add option for transforming gas into heat using gas boilers.
oil_boilers	bool	{true, false}	Add option for transforming oil into heat using boilers.
chp	bool	{true, false}	Add option for using Combined Heat and Power (CHP).
micro_chp	bool	{true, false}	Add option for using gas-fired Combined Heat and Power (CHP) for decentral areas.
solar_thermal	bool	{true, false}	Add option for using solar thermal to generate heat.
heat_pump_sink_T	celcius	nan	The temperature heat sink used in heat pumps based on DTU / large area radiators. The value is conservatively high to cover hot water and space heating in poorly-insulated buildings.
time_dep_hp_cop	bool	{true, false}	Consider the time dependent coefficient of performance (COP) of the heat pump.
solar_cf_correction	float	nan	The correction factor for the value provided by the solar thermal profile calculations.

land transport sector

  # ------------------- LAND TRANSPORT SECTOR -------------------

  bev_plug_to_wheel_efficiency: 0.2 #kWh/km from EPA https://www.fueleconomy.gov/feg/ for Tesla Model S
  bev_charge_efficiency: 0.9 #BEV (dis-)charging efficiency
  transport_heating_deadband_upper: 20.
  transport_heating_deadband_lower: 15.
  ICE_lower_degree_factor: 0.375 #in per cent increase in fuel consumption per degree above deadband
  ICE_upper_degree_factor: 1.6
  EV_lower_degree_factor: 0.98
  EV_upper_degree_factor: 0.63
  bev_avail_max: 0.95
  bev_avail_mean: 0.8
  bev_dsm_restriction_value: 0.75 #Set to 0 for no restriction on BEV DSM
  bev_dsm_restriction_time: 7 #Time at which SOC of BEV has to be dsm_restriction_value
  v2g: true #allows feed-in to grid from EV battery
  bev_dsm: true #turns on EV battery
  bev_energy: 0.05 #average battery size in MWh
  bev_availability: 0.5 #How many cars do smart charging
  transport_fuel_cell_efficiency: 0.5
  transport_internal_combustion_efficiency: 0.3

  land_transport_fuel_cell_share: # 1 means all FCEVs HERE
    BU_2030: 0.00
    AP_2030: 0.004
    NZ_2030: 0.02
    DF_2030: 0.01
    AB_2030: 0.01
    BU_2050: 0.00
    AP_2050: 0.06
    NZ_2050: 0.28
    DF_2050: 0.08
  land_transport_electric_share: # 1 means all EVs  # This leads to problems when non-zero HERE
    BU_2030: 0.00
    AP_2030: 0.075
    NZ_2030: 0.13
    DF_2030: 0.01
    AB_2030: 0.01
    BU_2050: 0.00
    AP_2050: 0.42
    NZ_2050: 0.68
    DF_2050: 0.011

  dynamic_transport:
    enable: false # If "True", then the BEV and FCEV shares are obtained depending on the "Co2L"-wildcard (e.g. "Co2L0.70: 0.10"). If "False", then the shares are obtained depending on the "demand" wildcard and "planning_horizons" wildcard as listed below (e.g. "DF_2050: 0.08")
    land_transport_fuel_cell_share:
      Co2L2.0: 0.01
      Co2L1.0: 0.01
      Co2L0.90: 0.01
      Co2L0.80: 0.01
      Co2L0.70: 0.01
      Co2L0.60: 0.01
      Co2L0.50: 0.01
      Co2L0.40: 0.01
      Co2L0.30: 0.01
      Co2L0.20: 0.01
      Co2L0.10: 0.01
      Co2L0.00: 0.01
    land_transport_electric_share:
      Co2L2.0: 0.00
      Co2L1.0: 0.01
      Co2L0.90: 0.03
      Co2L0.80: 0.06
      Co2L0.70: 0.10
      Co2L0.60: 0.17
      Co2L0.50: 0.27
      Co2L0.40: 0.40
      Co2L0.30: 0.55
      Co2L0.20: 0.69
      Co2L0.10: 0.80
      Co2L0.00: 0.88

Parameter	Unit	Values	Description
bev_plug_to_wheel_efficiency	kWh/km	nan	The distance traveled per energy used of battery electric vehicles (BEV). Default inputs are based on EPA estimation for Tesla Model S https://www.fueleconomy.gov/feg/.
bev_charge_efficiency	float	[0, 1]	Battery electric vehicles (BEV) charge and discharge efficiency.
transport_heating_deadband_upper	float	nan	The maximum temperature in the vehicle. At higher temperatures, the energy required for cooling in the vehicle increases.
transport_heating_deadband_lower	float	nan	The minimum temperature in the vehicle. At lower temperatures, the energy required for heating in the vehicle increases.
ICE_lower_degree_factor	float	nan	Share increase in energy demand in internal combustion engine (ICE) for each degree difference between the cold environment and the minimum temperature.
ICE_upper_degree_factor	float	nan	Share increase in energy demand in internal combustion engine (ICE) for each degree difference between the hot environment and the maximum temperature.
EV_lower_degree_factor	float	nan	Share increase in energy demand in electric vehicles (EV) for each degree difference between the cold environment and the minimum temperature.
EV_upper_degree_factor	float	nan	Share increase in energy demand in electric vehicles (EV) for each degree difference between the hot environment and the maximum temperature.
bev_avail_max	float	[0, 1]	The maximum share plugged-in availability for passenger electric vehicles.
bev_avail_mean	float	[0, 1]	The average share plugged-in availability for passenger electric vehicles.
bev_dsm_restriction_value	float	nan	Adds a lower state of charge (SOC) limit for battery electric vehicles (BEV) to manage its own energy demand (DSM). Located in prepare_transport_data.py <https://github.com/PyPSA/pypsa-earth/blob/master/scripts/prepare_transport_data.py>_. Set to 0 for no restriction on BEV DSM.
bev_dsm_restriction_time	float	nan	Time at which SOC of BEV has to be dsm_restriction_value.
v2g	bool	{true, false}	Allows feed-in to grid from EV battery. This is only enabled if BEV demand-side management is enabled, and the share of vehicles participating is V2G is given by bev_availability.
bev_dsm	bool	{true, false}	Add the option for battery electric vehicles (BEV) to participate in demand-side management (DSM).
bev_energy	MWh/car	nan	The average size of battery electric vehicles (BEV) in MWh.
bev_availability	float	nan	The share for battery electric vehicles (BEV) that are able to do demand side management (DSM).
transport_fuel_cell_efficiency	float	[0, 1]	The H2 conversion efficiencies of fuel cells in transport.
transport_internal_combustion_efficiency	float	[0, 1]	The oil conversion efficiencies of internal combustion engine (ICE) in transport.
land_transport_fuel_cell_share	float/dict	[0, 1] or {demand}_{planning_horizons}: [0, 1]	The share of vehicles that uses fuel cells in a given demand wildcard and given year.
land_transport_electric_share	float/dict	[0, 1] or {demand}_{planning_horizons}: [0, 1]	The share of vehicles that uses electric vehicles (EV) in a given demand wildcard and given year.
dynamic_transport
-- enable	bool	{true, false}	If 'True', then the BEV and FCEV shares are obtained depending on the 'Co2L'-wildcard (e.g. 'Co2L0.70: 0.10'). If 'False', then the shares are obtained depending on the 'demand' wildcard and 'planning_horizons' wildcard as listed below (e.g. 'DF_2050: 0.08')
-- land_transport_fuel_cell_share	float/dict	[0, 1] or {opts}_{planning_horizons}: [0, 1]	The share of vehicles that uses fuel cells in a given Co2L wildcard and given year.
-- land_transport_electric_share	float/dict	[0, 1] or {opts}_{planning_horizons}: [0, 1]	The share of vehicles that uses electric vehicles (EV) in a given Co2L wildcard and given year.

biomass sector

  # ------------------- BIOMASS SECTOR -------------------

  biomass_transport: true # biomass transport between nodes
  biomass_transport_default_cost: 0.1 #EUR/km/MWh
  solid_biomass_potential: 40 # TWh/a, Potential of whole modelled area
  biogas_potential: 0.5 # TWh/a, Potential of whole modelled area

Parameter	Unit	Values	Description
biomass_transport	bool	{true, false}	Add option for transporting solid biomass between nodes.
biomass_transport_default_cost	currency/km/MWh	nan	The cost of transporting one MWh of biomass per kilometer.
solid_biomass_potential	TWh/a	nan	The solid biomass potential in the model per year and investment period.
biogas_potential	TWh/a	nan	The biogas potential in the model per year and investment period.

electricity distribution grid

  # ------------------- ELECTRICITY DISTRIBUTION GRID -------------------

  electricity_distribution_grid: true # adds low voltage buses and shifts AC loads, BEVs, heat pumps, and resistive heaters, micro CHPs to low voltage buses if technologies are present
  enable_electricity_connection_cost: false # adds electricity grid connection costs to fixed capital costs for solar and onwind generators in prepare_sector_network.
  solar_rooftop: # adds distribution side customer rooftop PV (only work if electricity_distribution_grid: true)
    enable: true
    kW_per_m2: 0.1
    m2_per_person: 20
    use_building_size: false
    # proportion of rooftop suitable for PV installation
    install_ratio:
      0: 0
      10: 0.3
      100: 0.36
      200: 0.41
      450: 0.49
      2300: 0.66
     # maximum distance [km] to allocate a building within the nearest bus shapes
    tolerance: 100

  home_battery: true # adds home batteries to low voltage buses ((only work if electricity_distribution_grid: true)
  transmission_efficiency:
    electricity distribution grid:
      efficiency_static: 0.97 # efficiency of distribution grid (i.e. 3% loses)
    H2 pipeline:
      efficiency_per_1000km: 1
      compression_per_1000km: 0.017 # DEA technology data. Mean of  Energy losses, lines 5000-20000 MW and lines >20000 MW for 2020, 2030 and 2050, [%/1000 km]

Parameter	Unit	Values	Description
electricity_distribution_grid	bool	{true, false}	Add a simplified representation of the exchange capacity between transmission and distribution grid level through a link.
enable_electricity_connection_cost	bool	{true, false}	Adds electricity grid connection costs to fixed capital costs for solar and onwind generators in prepare_sector_network.
solar_rooftop
-- enable	bool	{true, false}	Add option for using solar rooftops to generate electricity in the distribution grid level.
-- kW_per_m2	kW/m2	nan	Estimate the kW of PV that can be installed per square meter of rooftop.
-- m2_per_person	m2/person	nan	If use_building_size is False, estimate the size of rooftop per capita.
-- use_building_size	bool	{true, false}	If True, estimate the area where solar rooftops can be placed using global building datasets.
-- install_ratio	dict	rooftop size: percentage of rooftop area	The usable solar rooftop area for buildings when considering that only a portion of each rooftop can be allocated for PV installation based on its size.
-- tolerance	nan	nan	Maximum distance in kilometers for spatial join to find nearest country shapes.
home_battery	bool	{true, false}	Add option for using home batteries to store electricity in the distribution grid level.
transmission_efficiency
-- electricity distribution grid
-- -- efficiency_static	float	[0, 1]	Electricity distribution grid transmission efficiency.
-- H2 pipeline
-- -- efficiency_per_1000km	1/1000km	nan	H2 pipeline transmission efficiency per 1000km
-- -- compression_per_1000km	1/1000km	nan	H2 pipeline transmission compression demand per 1000km

shipping & aviation sector

  # ------------------- SHIPPING & AVIATION SECTOR -------------------

  shipping_hydrogen_liquefaction: false
  shipping_average_efficiency: 0.4 #For conversion of fuel oil to propulsion in 2011
  shipping_hydrogen_share: #1.0
    BU_2030: 0.00
    AP_2030: 0.00
    NZ_2030: 0.10
    DF_2030: 0.05
    AB_2030: 0.05
    BU_2050: 0.00
    AP_2050: 0.25
    NZ_2050: 0.36
    DF_2050: 0.12
  airport_sizing_factor: 3
  international_bunkers: false #Whether or not to count the emissions of international aviation and navigation

Parameter	Unit	Values	Description
shipping_hydrogen_liquefaction	bool	{true, false}	Whether to include liquefaction costs for hydrogen demand in shipping.
shipping_average_efficiency	float	[0, 1]	The efficiency of hydrogen-powered ships in the conversion of hydrogen to meet shipping needs (fuel cell).
shipping_hydrogen_share	float/dict	[0, 1] or {demand}_{planning_horizons}: [0, 1]	The share of ships powered by hydrogen in a given year.
airport_sizing_factor	float	nan	Size of large airports relative to medium-sized airports.
international_bunkers	bool	{true, false}	Whether or not to count the emissions of international aviation and navigation

ccus & conversion options

  # ------------------- CCUS & CONVERSION OPTIONS -------------------

  co2_network: true
  co2_sequestration_potential: 200 #MtCO2/a sequestration potential for Europe
  co2_sequestration_cost: 10 #EUR/tCO2 for sequestration of CO2

  methanation: true
  helmeth: true
  dac: true
  cc_fraction: 0.9
  cc: true
  fischer_tropsch: true
  min_part_load_fischer_tropsch: 0.9

Parameter	Unit	Values	Description
co2_network	bool	{true, false}	Add option for planning a new carbon dioxide transmission network.
co2_sequestration_potential	MtCO2/a	nan	The potential of sequestering CO2 in the model per year and investment period.
co2_sequestration_cost	currency/tCO2	nan	The cost of sequestering a ton of CO2 (currency/tCO2).
methanation	bool	{true, false}	Add option for transforming hydrogen and CO2 into methane using methanation.
helmeth	bool	{true, false}	Add option for transforming electricity and CO2 into methane using HELMETH (Integrated High-Temperature ELectrolysis and METHanation).
dac	bool	{true, false}	Add option for Direct Air Capture (DAC).
cc_fraction	float	[0, 1]	The default fraction of CO2 captured with post-combustion capture.
cc	bool	{true, false}	Add option for carbon capture (CC).
fischer_tropsch	bool	{true, false}	Add option for converting H2 and CO2 into oil (Fischer Tropsch).
min_part_load_fischer_tropsch	float	[0, 1]	The minimum unit dispatch (p_min_pu) for the Fischer-Tropsch process.

industry options

  # ------------------- INDUSTRY OPTIONS -------------------

  industry_util_factor: 0.7

  efficiency_heat_oil_to_elec: 0.9
  efficiency_heat_biomass_to_elec: 0.9
  efficiency_heat_gas_to_elec: 0.9

Parameter	Unit	Values	Description
industry_util_factor	float	[0, 1]	Industry utility fraction in generating process emission
efficiency_heat_oil_to_elec	float	[0, 1]	The heat efficiency of oil if that energy is supplied using electricity instead. Used to determine residential electricity.
efficiency_heat_biomass_to_elec	float	[0, 1]	The heat efficiency of biomass if that energy is supplied using electricity instead. Used to determine residential electricity.
efficiency_heat_gas_to_elec	float	[0, 1]	The heat efficiency of gas if that energy is supplied using electricity instead. Used to determine residential electricity.

powerplants options

  # ------------------- POWERPLANTS OPTIONS -------------------

  conventional_generation: # generator : carrier
    OCGT: gas
    CCGT: gas
    oil: oil
    coal: coal
    lignite: lignite
    biomass: biomass
  keep_existing_capacities: false

  marginal_cost_storage: 0

Parameter	Unit	Values	Description
conventional_generation	dict	generator : carrier	Add a more detailed description of conventional carriers. Any power generation requires the consumption of fuel from nodes representing that fuel.
keep_existing_capacities	bool	{true, false}	Add options to keep powerplant capacities previously assigned in add_electricity.
marginal_cost_storage	currency/MW	nan	The default marginal cost of storage technologies.

solving

Specify linear power flow formulation and optimization solver settings.

options

  options:
    formulation: kirchhoff
    load_shedding: 100 # Set to "false" or willingness to pay in €/kWh, e.g. 100 €/kWh (intersect between macroeconomic and surveybased willingness to pay https://doi.org/10.3389/fenrg.2015.00055)
    noisy_costs: true
    min_iterations: 4
    max_iterations: 6
    clip_p_max_pu: 0.01
    skip_iterations: true
    track_iterations: false
    # nhours: 10

Parameter	Unit	Values	Description
formulation	--	{angles, kirchhoff, cycles, ptdf}	Specifies which variant of linearized power flow formulations to use in the optimisation problem. Recommended is 'kirchhoff'.
load_shedding	--	Either 'false' or float	Add generators with a prohibitively high marginal cost to simulate load shedding. Choose 'false' to turn off or alternatively add willingness to pay for load shedding in EUR/kWh
noisy_costs	bool	{true, false}	Add random noise to marginal cost of generators and capital cost of lines and links.
min_iterations	--	int	Minimum number of solving iterations in between which resistance and reactance (x/r) are updated for branches according to s_nom_opt of the previous run.
max_iterations	--	int	Maximum number of solving iterations in between which resistance and reactance (x/r) are updated for branches according to s_nom_opt of the previous run.
clip_p_max_pu	p.u.	float	To avoid too small values in the renewables per-unit availability time series values below this threshold are set to zero.
skip_iterations	bool	{true, false}	Skip iterating, do not update impedances of branches.
track_iterations	bool	{true, false}	Flag whether to store the intermediate branch capacities and objective function values are recorded for each iteration.
nhours	--	int	Specifies the n first snapshots to take into account. Must be less than the total number of snapshots. Recommended only for debugging.

solver

  solver:
    name: gurobi
    options: gurobi-default

Parameter	Unit	Values	Description
name	--	One of {'gurobi', 'cplex', 'cbc', 'glpk', 'ipopt'}; potentially more possible	Solver to use for optimisation problems in the workflow; e.g. clustering and linear optimal power flow.
opts	--	Parameter list for Gurobi and CPLEX	Solver specific parameter settings.

plotting

Specifies plotting options.

plotting:
  map:
    figsize: [7, 7]
    boundaries: [-10.2, 29, 35, 72]
    p_nom:
      bus_size_factor: 5.e+4
      linewidth_factor: 3.e+3
    color_geomap:
      ocean: white
      land: whitesmoke

  costs_max: 10
  costs_threshold: 0.2

  energy_max: 20000
  energy_min: -20000
  energy_threshold: 15

  vre_techs:
  - onwind
  - offwind-ac
  - offwind-dc
  - solar
  - ror
  conv_techs:
  - OCGT
  - CCGT
  - nuclear
  - Nuclear
  - coal
  - oil
  storage_techs:
  - hydro+PHS
  - battery
  - H2
  renewable_storage_techs:
  - PHS
  - hydro
  load_carriers:
  - AC load
  AC_carriers:
  - AC line
  - AC transformer
  link_carriers:
  - DC line
  - Converter AC-DC
  heat_links:
  - heat pump
  - resistive heater
  - CHP heat
  - CHP electric
  - gas boiler
  - central heat pump
  - central resistive heater
  - central CHP heat
  - central CHP electric
  - central gas boiler
  heat_generators:
  - gas boiler
  - central gas boiler
  - solar thermal collector
  - central solar thermal collector

  tech_colors:
    onwind: "#235ebc"
    onshore wind: "#235ebc"
    offwind: "#6895dd"
    offwind-ac: "#6895dd"
    offshore wind: "#6895dd"
    offshore wind ac: "#6895dd"
    offshore wind (AC): "#6895dd"
    offwind-dc: "#74c6f2"
    offshore wind dc: "#74c6f2"
    offshore wind (DC): "#74c6f2"
    wave: "#004444"
    hydro: "#08ad97"
    hydro+PHS: "#08ad97"
    PHS: "#08ad97"
    hydro reservoir: "#08ad97"
    hydroelectricity: "#08ad97"
    ror: "#4adbc8"
    run of river: "#4adbc8"
    solar: "#f9d002"
    solar PV: "#f9d002"
    solar thermal: "#ffef60"
    solar rooftop: "#ffef60"
    biomass: "#0c6013"
    solid biomass: "#06540d"
    solid biomass for industry co2 from atmosphere: "#654321"
    solid biomass for industry co2 to stored: "#654321"
    solid biomass for industry CC: "#654321"
    biogas: "#23932d"
    waste: "#68896b"
    geothermal: "#ba91b1"
    OCGT: "#d35050"
    OCGT marginal: "sandybrown"
    OCGT-heat: "#ee8340"
    CCGT: "#b80404"
    gas: "#d35050"
    natural gas: "#d35050"
    gas boiler: "#ee8340"
    gas boilers: "#ee8340"
    gas boiler marginal: "#ee8340"
    gas-to-power/heat: "brown"
    SMR: "#4F4F2F"
    SMR CC: "darkblue"
    oil: "#262626"
    oil boiler: "#B5A642"
    oil emissions: "#666666"
    gas for industry: "#333333"
    gas for industry CC: "brown"
    gas for industry co2 to atmosphere: "#654321"
    gas for industry co2 to stored: "#654321"
    nuclear: "#ff9000"
    Nuclear: "r"
    Nuclear marginal: "r"
    uranium: "r"
    coal: "#707070"
    Coal: "k"
    Coal marginal: "k"
    lignite: "#9e5a01"
    Lignite: "grey"
    Lignite marginal: "grey"
    H2: "#ea048a"
    H2 export: "#ea048a"
    H2 for industry: "#222222"
    H2 for shipping: "#6495ED"
    H2 liquefaction: "m"
    hydrogen storage: "#ea048a"
    battery: "slategray"
    battery discharger: "slategray"
    battery charger: "slategray"
    EV battery storage: "slategray"
    home battery: "#614700"
    home battery storage: "#614700"
    lines: "#70af1d"
    transmission lines: "#70af1d"
    AC: "#70af1d"
    AC-AC: "#70af1d"
    AC line: "#70af1d"
    links: "#8a1caf"
    HVDC links: "#8a1caf"
    DC: "#8a1caf"
    DC-DC: "#8a1caf"
    DC link: "#8a1caf"
    load: "#ff0000"
    load shedding: "#ff0000"
    Electric load: "b"
    electricity: "k"
    electric demand: "k"
    electricity distribution grid: "y"
    heat: "darkred"
    Heat load: "r"
    heat pumps: "#76EE00"
    heat pump: "#76EE00"
    air heat pump: "#76EE00"
    ground heat pump: "#40AA00"
    CHP: "r"
    CHP heat: "r"
    CHP electric: "r"
    heat demand: "darkred"
    rural heat: "#880000"
    central heat: "#b22222"
    decentral heat: "#800000"
    low-temperature heat for industry: "#991111"
    process heat: "#FF3333"
    power-to-heat: "red"
    resistive heater: "pink"
    Sabatier: "#FF1493"
    methanation: "#FF1493"
    power-to-gas: "purple"
    power-to-liquid: "darkgreen"
    helmeth: "#7D0552"
    DAC: "deeppink"
    co2 stored: "#123456"
    CO2 pipeline: "gray"
    CO2 sequestration: "#123456"
    co2: "#123456"
    co2 vent: "#654321"
    process emissions: "#222222"
    process emissions CC: "gray"
    process emissions to stored: "#444444"
    process emissions to atmosphere: "#888888"
    agriculture heat: "#D07A7A"
    agriculture machinery oil: "#1e1e1e"
    agriculture machinery oil emissions: "#111111"
    agriculture electricity: "#222222"
    Fischer-Tropsch: "#44DD33"
    kerosene for aviation: "#44BB11"
    naphtha for industry: "#44FF55"
    land transport oil: "#44DD33"
    land transport oil emissions: "#666666"
    land transport fuel cell: "#AAAAAA"
    land transport EV: "grey"
    V2G: "grey"
    BEV charger: "grey"
    shipping: "#6495ED"
    shipping oil: "#6495ED"
    shipping oil emissions: "#6495ED"
    water tanks: "#BBBBBB"
    hot water storage: "#BBBBBB"
    hot water charging: "#BBBBBB"
    hot water discharging: "#999999"
    Li ion: "grey"
    district heating: "#CC4E5C"
    retrofitting: "purple"
    building retrofitting: "purple"
    solid biomass transport: "green"
    biomass EOP: "green"
    high-temp electrolysis: "magenta"
    today: "#D2691E"
    Ambient: "k"
    industry coal emissions: "#654321"
    agriculture oil: "#1e1e1e"
    gas emissions: "#666666"
    industry oil emissions: "#654321"
    industry electricity: "#222222"
    rail transport electricity: "grey"
    solid biomass for industry: "#654321"
    rail transport oil: "#44DD33"
    low voltage: "y"


  nice_names:
    OCGT: Open-Cycle Gas
    CCGT: Combined-Cycle Gas
    offwind-ac: Offshore Wind (AC)
    offwind-dc: Offshore Wind (DC)
    onwind: Onshore Wind
    solar: Solar
    PHS: Pumped Hydro Storage
    hydro: Reservoir & Dam
    battery: Battery Storage
    H2: H2
    lines: Transmission Lines
    ror: Run of River

Parameter	Unit	Values	Description
map	nan	nan	nan
-- figsize	--	[width, height]; e.g. [7,7]	Figure size in inches.
-- boundaries	°	[x1,x2,y1,y2]	Boundaries of the map plots in degrees latitude (y) and longitude (x)
-- p_nom	nan	nan	nan
-- -- bus_size_factor	--	float	Factor by which values determining bus sizes are scaled to fit well in the plot.
-- -- linewidth_factor	--	float	Factor by which values determining bus sizes are scaled to fit well in the plot.
costs_max	bn Euro	float	Upper y-axis limit in cost bar plots.
costs_threshold	bn Euro	float	Threshold below which technologies will not be shown in cost bar plots.
energy_max	TWh	float	Upper y-axis limit in energy bar plots.
energy_min	TWh	float	Lower y-axis limit in energy bar plots.
energy_threshold	TWh	float	Threshold below which technologies will not be shown in energy bar plots.
tech_colors	--	carrier -> HEX colour code	Mapping from network carrier to a colour (HEX colour code).
nice_names	--	str -> str	Mapping from network carrier to a more readable name.