Spellings

Warning

This documentaion page is comprehensive.

Recommended way of using this doc page is the search function (strg+f)

Checking if a certain spelling is supported i.e. variable_cost for reading in flow cost data is done by prgogramatically browsing this page:

Press strg+f

Type variable_cost

If nothing is found renaming the key is recommended

If somehting is found, check the table heading (flow_costs in this example)

Use this key as parameter for get_from.smth_like to map variable_cost to flow_costs for reading in and succesfully parsing data.

Auxiliaries

`get_from`	Map different spellings of the same string key to one specific spelling.
`seperators`	Seperators used for combined string expressions.
`variation_base`	Variation base keys used for creating possible spellings.

Supported Models

`calliope`	Supported `calliope` spellings
`fine`	Supported `fine` spellings
`oemof`	Supported `oemof` spellings
`pypsa`	Supported `pypsa` spellings

Unique Identifier Components (Parts making up the UID)

`name`	Supported `name` spellings
`latitude`	Supported `latitude` spellings
`longitude`	Supported `longitude` spellings
`region`	Supported `region` spellings
`sector`	Supported `sector` spellings
`carrier`	Supported `carrier` spellings
`node_type`	Supported `node_type` spellings

Time Serieses

`timeindex`	Supported `timeindex` spellings
`timeseries`	Supported `timeseries` spellings
`timeframe`	Supported `timeframe` spellings

Global Constraints

global_constraints

Supported global_constraints spellings

TESSiF’s Energy System Model

`accumulated_amounts`	Supported `accumulated_amounts` spellings
`costs_for_being_active`	Supported `costs_for_being_active` spellings
`expandable`	Supported `expandable` spellings
`expansion_costs`	Supported `expansion_costs` spellings
`expansion_limits`	Supported `expansion_limits` spellings
`flow_costs`	Supported `flow_costs` spellings
`flow_emissions`	Supported `flow_emissions` spellings
`flow_gradients`	Supported `flow_gradients` spellings
`flow_rates`	Supported `flow_rates` spellings
`gradient_costs`	Supported `gradient_costs` spellings
`idle_changes`	Supported `idle_changes` spellings
`initial_soc`	Supported `initial_soc` spellings.
`initial_status`	Supported `initial_status` spellings.
`inputs`	Supported `inputs` spellings
`number_of_status_changes`	Supported `number_of_status_changes` spellings
`status_inertia`	Supported `status_inertia` spellings
`status_changing_costs`	Supported `status_changing_costs` spellings
`outputs`	Supported `outputs` spellings

Component Parameters as Singular Values

`accumulated_maximum`	Supported `accumulated_maximum` spellings.
`accumulated_minimum`	Supported `accumulated_minimum` spellings.
`active`	Supported `active` spellings
`efficiency`	Supported `efficiency` spellings
`emissions`	Supported `emissions` spellings.
`exogenously_set`	Supported `exogenously_set` spellings.
`exogenously_set_value`	Supported `exogenously_set_value` spellings.
`expansion_costs`	Supported `expansion_costs` spellings
`expansion_problem`	Supported `expansion_problem` spellings
`gain_rate`	Supported `gain_rate` spellings.
`input`	Supported `input` spellings
`installed_capacity`	Supported `installed_capacity` spellings.
`loss_rate`	Supported `loss_rate` spellings
`maximum`	Supported `maximum` spellings.
`maximum_efficiency`	Supported `maximum_efficiency` spellings
`maximum_expansion`	Supported `maximum_expansion` spellings
`minimum`	Supported `minimum` spellings.
`minimum_efficiency`	Supported `minimum_efficiency` spellings
`minimum_expansion`	Supported `minimum_expansion` spellings
`minimum_downtime`	Supported `minimum_downtime` spellings.
`minimum_uptime`	Supported `minimum_uptime` spellings.
`negative_gradient`	Supported `negative_gradient` spellings.
`negative_gradient_costs`	Supported `negative_gradient_costs` spellings.
`output`	Supported `output` spellings
`positive_gradient`	Supported `positive_gradient` spellings.
`positive_gradient_costs`	Supported `positive_gradient_costs` spellings.
`shutdown_costs`	Supported `shutdown_costs` spellings.
`startup_costs`	Supported `startup_costs` spellings.
`storage_capacity`	Supported `storage_capacity` spellings.

Input Output Seperation

`inflow_costs`	Supported `inflow_costs` spellings
`inflow_efficiency`	Supported `inflow_efficiency` spellings
`inflow_emissions`	Supported `inflow_emissions` spellings.
`input_maximum`	Supported `input_maximum` spellings
`input_minimum`	Supported `input_minimum` spellings
`input_negative_gradient`	Supported `input_negative_gradient` spellings.
`input_positive_gradient`	Supported `input_positive_gradient` spellings.
`outflow_costs`	Supported `outflow_costs` spellings
`outflow_efficiency`	Supported `outflow_efficiency` spellings
`outflow_emissions`	Supported `outflow_emissions` spellings
`output_maximum`	Supported `output_maximum` spellings
`output_minimum`	Supported `output_minimum` spellings
`output_negative_gradient`	Supported `output_negative_gradient` spellings.
`output_positive_gradient`	Supported `output_positive_gradient` spellings.

Component Parameters as Series Values

`efficiency_n`	Supported `efficiency_n` spellings
`emissions_n`	Supported `emissions_n` spellings.
`flow_costs_n`	Supported `flow_costs_n` spellings
`fraction_n`	Supported `fraction_n` spellings.
`inflow_costs_n`	Supported `inflow_costs_n` spellings.
`inflow_emissions_n`	Supported `inflow_emissions_n` spellings.
`input_n`	Supported `input_n` spellings
`outflow_costs_n`	Supported `outflow_costs_n` spellings.
`outflow_emissions_n`	Supported `outflow_emissions_n` spellings.
`output_n`	Supported `output_n` spellings

Oemof Specific Component Parameters

`already_installed`	Supported `already_installed` spellings.
`back_pressure`	Supported `back_pressure` spellings.
`maximum_extraction`	Supported `maximum_extraction` spellings
`maximum_fuelgas_losses`	Supported `maximum_fuelgas_losses` spellings
`maximum_heat`	Supported `maximum_heat` spellings
`maximum_power`	Supported `maximum_power` spellings
`milp`	Supported `milp` spellings.
`minimum_extraction`	Supported `minimum_extraction` spellings
`minimum_fuelgas_losses`	Supported `minimum_fuelgas_losses` spellings
`minimum_heat`	Supported `minimum_heat` spellings
`minimum_power`	Supported `minimum_power` spellings
`fraction`	Supported `fraction` spellings
`fuel_in`	Supported `fuel_in` spellings
`fuelgas_losses`	Supported `fuelgas_losses` spellings
`heat_costs`	Supported `heat_costs` spellings
`heat_efficiency`	Supported `heat_efficiency` spellings
`heat_emissions`	Supported `heat_emissions` spellings
`heat_out`	Supported `heat_out` spellings
`ideal`	Supported `ideal` spellings.
`lower_heating_value`	Supported `lower_heating_value` spellings.
`nominal_value`	Supported `nominal_value` spellings.
`number_of_connections`	Supported `number_of_connections` spellings
`power_costs`	Supported `power_costs` spellings
`power_efficiency`	Supported `power_efficiency` spellings
`power_emissions`	Supported `power_emissions` spellings
`power_loss_index`	Supported `power_loss_index` spellings
`power_out`	Supported `power_out` spellings
`upper_heating_value`	Supported `upper_heating_value` spellings

Energy System Component Identifers

`bus`	Supported `bus` spellings.
`sink`	Supported `sink` spellings.
`storage`	Supported `storage` spellings.
`source`	Supported `source` spellings.
`transformer`	Supported `transformer` spellings.
`connector`	Supported `connector` spellings.

Energy System Component Identifers - Energy Carrier

`solar`	Supported `solar` spellings.
`wind`	Supported `wind` spellings.
`water`	Supported `water` spellings.
`biomass`	Supported `biomass` spellings.
`commodity`	Supported `commodity` spellings.
`gas`	Supported `gas` spellings.
`oil`	Supported `oil` spellings.
`lignite`	Supported `lignite` spellings.
`hardcoal`	Supported `hardcoal` spellings.
`nuclear`	Supported `nuclear` spellings.
`electricity`	Supported `electricity` spellings.
`steam`	Supported `steam` spellings.
`hot_water`	Supported `hot_water` spellings.

Energy System Component Identifers - Sector

`power`	Supported `power` spellings.
`heat`	Supported `heat` spellings.
`mobility`	Supported `mobility` spellings.
`coupled`	Supported `coupled` spellings.

Energy System Component Identifers - Label

`renewables`	Supported `renewables` spellings.
`photovoltaic`	Supported `photovoltaic` spellings.
`solarthermal`	Supported `solarthermal` spellings.
`onshore`	Supported `onshore` spellings.
`offshore`	Supported `offshore` spellings.
`hydro_electric`	Supported `hydro_electric` spellings.
`imported`	Supported `imported` spellings.
`mimo_transformer`	Supported `mimo_transformer` spellings.
`sito_flex_transformer`	Supported `sito_flex_transformer` spellings.
`generic_chp`	Supported `generic_chp` spellings.
`siso_nonlinear_transformer`	Supported `siso_nonlinear_transformer` spellings.
`combined_heat_power`	Supported `combined_heat_power` spellings.
`power_plant`	Supported `power_plant` spellings.
`heat_plant`	Supported `heat_plant` spellings.
`electrical_line`	Supported `electrical_line` spellings.
`gas_pipeline`	Supported `gas_pipeline` spellings.
`gas_delivery`	Supported `gas_delivery` spellings.
`oil_pipeline`	Supported `oil_pipeline` spellings.
`oil_delivery`	Supported `oil_delivery` spellings.
`generic_storage`	Supported `generic_storage` spellings.
`hydro_electrical_storage`	Supported `hydro_electrical_storage` spellings.
`electro_chemical_storage`	Supported `electro_chemical_storage` spellings.
`electro_mechanical_storage`	Supported `electro_mechanical_storage` spellings.
`thermal_energy_storage`	Supported `thermal_energy_storage` spellings.
`power2x`	Supported `power2x` spellings.
`backup`	Supported `backup` spellings.
`export`	Supported `export` spellings.
`excess`	Supported `excess` spellings.

Auxilliaries

Tessif’s supported spellings to facilitate input parsing.

spellings is a tessif subpackage aggregating aliases and variations tessif is able to parse as expected during data input.

It serves as tessif's main data input abstraction mechanism. Expanding these capabilities is best done here.

tessif.frused.spellings.get_from(dct, smth_like, dflt=None)[source]

Map different spellings of the same string key to one specific spelling.

Get smth_like from the string keyed dct otherwise return dflt.

Used through out tessif to allow a wide variaty of string mappings for descibing the same thing. Whenn accessing (somewhat) unknown or unfamiliar input data sources.

Parameters

dct¶ (dict) – Dictionairy to key key with something that looks like smth_like
smth_like¶ (str) – string representation of a key of which an identically named attribute is to be found in tessif.frused.spellings.
dflt¶ (value, default=None,) – value to return when no appropriate spelling exists in tessif.frused.spellings or no spelling variation of this key is present in dct

Note

A detailed debugging log is created to help with this sometimes error prone approach to allow arbitrarily many spellings for the same set of data.

All logs can be found in tessif.write.logs

The logging level can be tweaked using configurations.spellings_logging_level.

Examples

Design Case:

>>> from tessif.frused import spellings
>>> lookup = {'CO2 Emissions': 10,}
>>> print(get_from(lookup, smth_like='emissions'))
10

Unsuccessful matching between spellings variation and dict keys:

>>> from tessif.frused import spellings
>>> lookup = {'CO2 Emissions': 10,}
>>> print(get_from(lookup, smth_like='timeindex', dflt='Failed'))
Failed

Unsuccessful matching between smth_like and hardcoded mappings:

>>> from tessif.frused import spellings
>>> lookup = {'CO2 Emissions': 10,}
>>> print(get_from(lookup, smth_like='co2_emissions', dflt='42'))
42

tessif.frused.spellings.seperators: Seperators used for combined string expressions.

tessif.frused.spellings.variation_base

Variation base keys used for creating possible spellings.

Each of the following strings is a key to a “many->one” string representation mapping.

There is an identically named attribute for each mapping in tessif.frused.spellings.

Supported Models

tessif.frused.spellings.calliope: Supported calliope spellings

tessif.frused.spellings.fine: Supported fine spellings

tessif.frused.spellings.oemof: Supported oemof spellings

tessif.frused.spellings.pypsa: Supported pypsa spellings

Unique Identifiers Components (Parts making up the UID)

tessif.frused.spellings.name: Supported name spellings

tessif.frused.spellings.latitude: Supported latitude spellings

tessif.frused.spellings.longitude: Supported longitude spellings

tessif.frused.spellings.region: Supported region spellings

tessif.frused.spellings.sector: Supported sector spellings

tessif.frused.spellings.carrier: Supported carrier spellings

tessif.frused.spellings.node_type: Supported node_type spellings