Configuration parameters of Euro-Calliope's workflow#

Below you can find a complete enumeration of all configuration parameters of Euro-Calliope's workflow including short descriptions and datatypes. To learn where to find default values and how to change the parameter values for your model builds, head over to the Customisation section of the workflow documentation.

• email (string): Email address to notify of build successes or fails.
• data-sources (object): Paths and URLs to datasets. Cannot contain additional properties.
  • biofuel-potentials-and-costs (string): Web address of biofuel potentials and costs.
  • eez (string): Path to local geospatial Exclusive Economic Zones data.
  • hydro-generation (string): Web address of hydro generation data.
  • national-phs-storage-capacities (string): Web address of storage capacities data (in GWh).
  • capacity-factors (string): Web address of the capacity factor timeseries. Must contain {filename} placeholder.
  • gadm (string): Web address of geospatial GADM data. Must contain {country_code} placeholder.
  • hydro-basins (string): Web address of geospatial basins data.
  • hydro-stations (string): Web address of database of hydro stations.
  • load (string): Web address of load data.
  • nuts (string): Web address of geospatial NUTS data.
  • potentials (string): Web address of potentials of solar and wind.
  • entsoe-tyndp (string): Web address of ENTSOE Ten-Year Network Development Plan (TYNDP) scenario data files.
  • jrc-ppdb (string): Web address of JRC power plant database.
  • jrc-idees (string): Web address of JRC IDEES data.
  • eurostat-energy-balance (string): Web address of Eurostat energy balance data.
  • eurostat-hh-end-use (string): Web address of Eurostat household end use data.
  • swiss-end-use (string): Web address of Swiss annual energy consumption data.
  • swiss-energy-balance (string): Web address of Swiss energy balance data.
  • swiss-industry-energy-balance (string): Web address of Swiss industry energy balance data.
  • ev-data (string): Web address of electric vehicle data.
• data-pre-processing (object): Parameters for the pre-processing of raw data. Cannot contain additional properties.
  • fill-missing-values (object): Strategies to fill missing values. Cannot contain additional properties.
    • jrc-idees (object): Fill missing countries in JRC IDEES annual demand data. Cannot contain additional properties.
    • ramp (object): Fill missing countries in RAMP timeseries profiles. Cannot contain additional properties.
• root-directory (string): Path to the root directory of euro-calliope containing scripts and template folders.
• cluster-sync (object): Configuration for the "work local, build on remote" workflow. Cannot contain additional properties.
  • url (string): URL of the cluster.
  • send-ignore (string): Path to local file defining files and folders to ignore when sending to cluster (relative to workdir).
  • receive-ignore (string): Path to local file defining files and folders to ignore when receiving from cluster (relative to workdir).
  • cluster-base-dir (string): Path on cluster into which files are sent from local machine (must exist).
  • local-results-dir (string): Path to local folder into which results from cluster are downloaded (relative to workdir).
• scaling-factors (object): Factors to scale the optimisation problem to decrease its numerical range. Cannot contain additional properties.
  • power (number): Applied to all quantities of energy and power (base: MW(h)).
  • area (number): Applied to all quantities of area (base: km²).
  • monetary (number): Applied to all quantities of monetary cost (base: EUR).
• parameters (object): Parameter values of the models. Cannot contain additional properties.
  • maximum-installable-power-density (object): Installable capacity density in MW/km² (not annual energy yield). Cannot contain additional properties.
    • pv-on-tilted-roofs (number): (MW/km²). Minimum: 0.
    • pv-on-flat-areas (number): (MW/km²). Minimum: 0.
    • onshore-wind (number): (MW/km²). Minimum: 0.
    • offshore-wind (number): (MW/km²). Minimum: 0.
  • roof-share (object): Share of roofs by orientation (should add up to 1). Cannot contain additional properties.
    • E (number): East-facing roofs. Minimum: 0. Maximum: 1.
    • N (number): North-facing roofs. Minimum: 0. Maximum: 1.
    • S (number): South-facing roofs. Minimum: 0. Maximum: 1.
    • W (number): West-facing roofs. Minimum: 0. Maximum: 1.
    • flat (number): Flat roofs. Minimum: 0. Maximum: 1.
  • jrc-biofuel (object): Biofuel potential under different scenarios, to select specific data from [@Ruiz:2019]. Cannot contain additional properties.
    • scenario (string): Scenario for biofuel potential and cost estimate. Must be one of: ['low', 'medium', 'high'].
    • potential-year (number): Year for biomass potential estimate. Must be one of: [2010, 2020, 2030, 2040, 2050].
    • cost-year (number): Year for biomass cost estimate. Must be one of: [2010, 2020, 2030, 2040, 2050].
    • feedstocks (object): Feedstocks of biofuels.
      • bioethanol-sugar-beet: Refer to #/definitions/feedstock.
      • rapeseeds: Refer to #/definitions/feedstock.
      • oil-crops: Refer to #/definitions/feedstock.
      • starchy-crops: Refer to #/definitions/feedstock.
      • grassy-crops: Refer to #/definitions/feedstock.
      • willow: Refer to #/definitions/feedstock.
      • poplar: Refer to #/definitions/feedstock.
      • manure: Refer to #/definitions/feedstock.
      • primary-agricultural-residues: Refer to #/definitions/feedstock.
      • roundwood-fuelwood: Refer to #/definitions/feedstock.
      • roundwood-chips: Refer to #/definitions/feedstock.
      • forestry-energy-residues: Refer to #/definitions/feedstock.
      • secondary-forestry-residues-woodchips: Refer to #/definitions/feedstock.
      • secondary-forestry-residues-sawdust: Refer to #/definitions/feedstock.
      • landscape-care-residues: Refer to #/definitions/feedstock.
      • municipal-waste: Refer to #/definitions/feedstock.
      • sludge: Refer to #/definitions/feedstock.
  • biofuel-efficiency (number): Combustion efficiency of the biofuel technology. Minimum: 0. Maximum: 1.
  • wind-and-solar-potential-scenario (string): Scenario defining the amount of surfaces eligible for solar and wind power from [@Trondle:2019]. Must be one of: ['technical-potential', 'technical-social-potential'].
  • transport (object): Parameters for transport sector model. Cannot contain additional properties.
    • future-vehicle-efficiency-percentile (number): Percentile of vehicle efficiency across countries. Minimum: 0. Maximum: 1.
    • road-transport-conversion-factors (object): Electricity required per distance travelled (MWh / million km). Cannot contain additional properties.
      • light-duty-vehicles (number): Light duty vehicles / trucks.
      • heavy-duty-vehicles (number): Heavy duty vehicles / trucks.
      • coaches-and-buses (number): Coaches and buses.
      • passenger-cars (number): Passenger cars.
      • motorcycles (number): Motorcylces.
    • vehicle-type-names (object): Names of vehicle types in JRC-IDEES. Cannot contain additional properties.
      • light-duty-vehicles (string): JRC-IDEES name of light-duty-vehicles.
      • heavy-duty-vehicles (string): JRC-IDEES name of heavy-duty-vehicles.
      • coaches-and-buses (string): JRC-IDEES name of coaches-and-buses.
      • passenger-cars (string): JRC-IDEES name of passenger-cars.
      • motorcycles (string): JRC-IDEES name of motorcycles.
    • uncontrolled-ev-charging-share (number): Share of uncontrolled charging.
  • entsoe-tyndp (object): Parameters to define scenario choice for data accessed from the ENTSO-E ten-year network development plan 2020. For more information, see https://2020.entsos-tyndp-scenarios.eu/. Cannot contain additional properties.
    • scenario (string): High-level ENTSO-E TYNDP scenario. Must be one of: ['National Trends', 'Global Ambition', 'Distributed Energy'].
    • grid (string): High-level ENTSO-E TYNDP grid scenario. Must be one of: ['Reference', 'Expanded'].
    • projection-year (integer): ENTSO-E TYNDP model year. Must be one of: [2025, 2030, 2040].
    • ntc_limit (string): Limit on net-transfer capacity (NTC) between two regions to take as the value for that inter-regional exchange. Some NTCs are different depending on the direction of the link, but we are not capturing that in the technology definition. Must be one of: ['min', 'max'].
    • energy_cap_limit (string): How to use ENTSO-E-based NTCs to constrain link energy capacity in the Calliope model. Must be one of: ['min', 'equals', 'max'].
  • nuclear-capacity-scenario (string): Nuclear technology capacity scenario. "current" will use today's capacities based on the JRC power plant database (PPDB). All other scenario names should point to a configuration CSV file specifying minimum and maximum capacities per country in MW with non-zero capacities (columns=[country, min, max]).
  • heat (object): Parameters for heat sector model. Cannot contain additional properties.
    • space_heat (object): Parameters of space heating technologies. Cannot contain additional properties.
      • carnot-performance (number): Carnot performance.
      • gas-eff (number): Gas boiler efficiency.
      • oil-eff (number): Oil boiler efficiency.
      • solid-fossil-eff (number): Solid fossil boiler efficiency.
      • biofuel-eff (number): Biofuel boiler efficiency.
      • solar-thermal-eff (number): Solar thermal efficiency.
      • electricity-eff (number): Electric heater efficiency.
      • space-heat-temp (number): Space heating temperature.
      • hp-cop (number): Heat pump coefficient of performance.
    • water_heat (object): Parameters of water heating technologies. Cannot contain additional properties.
      • gas-eff (number): Gas boiler efficiency.
      • oil-eff (number): Oil boiler efficiency.
      • solid-fossil-eff (number): Solid fossil boiler efficiency.
      • biofuel-eff (number): Biofuel boiler efficiency.
      • solar-thermal-eff (number): Solar thermal efficiency.
      • electricity-eff (number): Electric heater efficiency.
      • water-heat-temp (number): Water heating temperature.
      • hp-cop (number): Heat pump coefficient of performance.
    • cooking (object): Parameters of cooking technologies. Cannot contain additional properties.
      • gas-eff (number): Gas stove efficiency.
      • oil-eff (number): Oil stove efficiency.
      • solid-fossil-eff (number): Solid fossil stove efficiency.
      • biofuel-eff (number): Biofuel stove efficiency.
      • electricity-eff (number): Electric stove efficiency.
• scope (object): Spatial and temporal scope bounding the models. Cannot contain additional properties.
  • spatial (object): The spatial scope of the models.
    • countries (array): Countries covered by the models.
      • Items (string): Must be one of: ['Austria', 'Belgium', 'Bulgaria', 'Croatia', 'Cyprus', 'Czech Republic', 'Denmark', 'Estonia', 'Finland', 'France', 'Germany', 'Greece', 'Hungary', 'Ireland', 'Italy', 'Latvia', 'Lithuania', 'Luxembourg', 'Netherlands', 'Poland', 'Portugal', 'Romania', 'Slovakia', 'Slovenia', 'Spain', 'Sweden', 'United Kingdom', 'Albania', 'Bosnia and Herzegovina', 'Macedonia, Republic of', 'Montenegro', 'Norway', 'Serbia', 'Switzerland'].
    • bounds (object): Bounding box describing the spatial extent of geographic datasets. Cannot contain additional properties.
      • x_min (number): Minimum longitude, in degrees east. Minimum: -180. Maximum: 180.
      • x_max (number): Maximum longitude, in degrees east. Minimum: -180. Maximum: 180.
      • y_min (number): Minimum Latitude, in degrees north. Minimum: -90. Maximum: 90.
      • y_max (number): Maximum Latitude, in degrees north. Minimum: -90. Maximum: 90.
  • temporal (object): The temporal scope of the models. Available range of 2010 - 2016 is set by electricity load data availability (lower bound) and capacity factor data availability (upper bound). Cannot contain additional properties.
    • first-year (integer): First model year, which will be used as the lower bound to subset data during processing. If subsetting to earlier than 2012 (i.e. 2010 or 2011), note that quality-control.load.acceptable-year-diff-for-gap-filling should be increased from its default value to handle missing load data in Albania. Minimum: 2010. Maximum: 2016.
    • final-year (integer): Final model year, which will be used as the upper bound (inclusive) to subset data during processing. To limit processing to only one year, set final-year to the same value as first-year. Minimum: 2010. Maximum: 2016.
• quality-control (object): Parameters controlling the data preprocessing steps. Cannot contain additional properties.
  • hydro (object): Parameters for the preprocessing of hydro data.
    • scale-phs-according-to-geth-et-al (boolean): Whether or not to use pumped hydro capacities derived from Geth et al. (2015) to scale pumped hydro capacities givven by the JRC hydro database.
    • station-nearest-basin-max-km (number): Move stations outside of hydrobasins into closest basin by max this amount (fails otherwise). Minimum: 0.
  • load (object): Data quality enforcing methods for open-power-system-data.org-derived national load data. These cover, in order: 1. remove outlier data hours, based on full dataset; 2. select only data for year of interest; 3. interpolate empty data when the data gap is small; 4. fill larger data gaps with data from nearby years; 5. if 29th of February is empty and couldn't previously be filled, use data from the 28th of February; 6. select most complete dataset for each country from list of data sources, based on a priority order. This process will fail if the 'most complete dataset' for any country has any remaining gaps.
    • outlier-data-thresholds (object)
      • relative-to-mean-min (number): Lower bound cut-off value for any hourly data relative to the annual mean load of a country. Any values below this lower bound will be replaced by interpolated values.
      • relative-to-mean-max (number): Upper bound cut-off value for any hourly data relative to the annual mean load of a country. Any values above this upper bound will be replaced by interpolated values.
    • max-interpolate-timesteps (integer): Maximum number of timesteps over which missing load data can be interpolated/extrapolated (refers to hours for the default load data). This value applies in both directions of an interpolation/extrapolation, so if it has a value of 2, the maximum interpolation is 4 and extrapolation (at either end of the timeseries) is 2. Even if the data gap > max-interpolate-timesteps, the gap will be filled up to the limit defined here.
    • acceptable-year-diff-for-gap-filling (integer): When filling data gaps in electricity load data, this specifies the absolute number of years from the current year that the model can use data for filling. A value of zero effectively removes this gap filling method.
    • fill-29th-feb-from-28th (boolean): Whether or not to gap-fill empty 29th of February data for leap years with data from the day before. If false, and no other leaps years are in the range of acceptable-year-diff-for-gap-filling and max-interpolate-timesteps < 12, the workflow will fail due to a data gap on this day.
    • data-source-priority-order (array): Order in which to prioritise available electricity load data from open-power-system-data.org. The first source in the list will be used to initialise the data; the remaining data sources in the list will be use to gap fill in order from first to last.
      • Items (string): Must be one of: ['actual_entsoe_power_statistics', 'actual_entsoe_transparency', 'actual_tso', 'actual_net_consumption_tso', 'actual_gross_generation_tso', 'forecast_entsoe_transparency', 'forecast_tso'].
  • capacity-factor-gridcell-overlap-threshold (number): Set the lower threshold of per-region land area covered by gridcells containing capacity factor timeseries data. Not all land area is covered by data because there are sometimes small islands linked to a region which are missed by the onshore wind / PV datasets. These islands are usually very small, consitituting less than 0.01% of a region. Minimum: 0. Maximum: 1.
• capacity-factors (object): Parameters related to average or time-dependent capacity factors of renewables. Cannot contain additional properties.
  • min (number): Set smaller values in time series to 0; this helps numerics in the LP. Minimum: 0.
  • max (number): Cap larger values in time series; this helps numerics in the LP (hydro reservoir can have > 1). Minimum: 0.
  • average (object): Average estimation used to transform annual fixed to variable costs.
    • pv (number): Average annual PV capacity factor. Minimum: 0.
    • onshore (number): Average annual onshore wind capacity factor. Minimum: 0.
    • offshore (number): Average annual offshore wind capacity factor. Minimum: 0.
    • ror (number): Average annual run-of-river hydro capacity factor. Minimum: 0.
  • trim-ninja-timeseries (boolean): If true, trims renewables.ninja time series to the year in question.
• crs (string): Coordinate reference system to which all geographic data will be conformed.
• sea-connections (object): Cannot contain additional properties.
• shapes (object): Source for geospatial shapes of all locations. The config must be consistent with data from https://doi.org/10.5281/zenodo.3244985. Cannot contain additional properties.

Definitions#

• feedstock (object)
  • include (boolean): Include this feedstock in the total biofuel potential.
  • id (string): The ID of the feedstock.
  • proxy (string): The spatial proxy to allocate national to subnational potentials. Must be one of: ['farmland', 'forest', 'population'].