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:

1. Press strg+f

2. Type variable_cost

3. If nothing is found renaming the key is recommended

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

5. 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.
to_csv	Store an iterable under name.csv having n columns in tessif/frused/spellings/name.csv.
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 Identifiers 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

efficiencyN	Supported efficiencyN spellings
emissionsN	Supported emissionsN spellings
flow_costsN	Supported flow_costsN spellings
fractionN	Supported fractionN spellings
inflow_costsN	Supported inflow_costsN spellings
inflow_emissionsN	Supported inflow_emissionsN spellings
inputN	Supported inputN spellings
outflow_costsN	Supported outflow_costsN spellings
outflow_emissionsN	Supported outflow_emissionsN spellings
outputN	Supported outputN 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

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.to_csv(iterable, name, columns=4, path=None, **kwargs)

Store an iterable under name.csv having n columns in tessif/frused/spellings/name.csv.

Parameters:

• iterable (Iterable) – The iterable used for constructing the csv table.

• name (str) – Table is stored in tessif/../doc/source/api/frused/spellings/name.csv

• columns (int, default=4) – Number of columns the csv table will have

• path (str, default=None) –

  String representation of the path the csv is written to. Default of None translates to:

  tessif_doc/source/api/frused/spellings/name.csv
  

• kwargs –

  kwargs are passed to pandas.DataFrame.to_csv

  Note

  index and header are set to False by default. Provide parameters for overriding those if needed.

tessif.frused.spellings.get_from(dct, smth_like, dflt=None)

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

Time Serieses

tessif.frused.spellings.timeframe

Supported timeframe spellings

tessif.frused.spellings.timeindex

Supported timeindex spellings

tessif.frused.spellings.timeseries

Supported timeseries spellings

Global Constraints

tessif.frused.spellings.global_constraints

Supported global_constraints spellings

TESSiF’s Energy System Model

tessif.frused.spellings.accumulated_amounts

Supported accumulated_amounts spellings

tessif.frused.spellings.costs_for_being_active

Supported costs_for_being_active spellings

tessif.frused.spellings.expandable

Supported expandable spellings

tessif.frused.spellings.expansion_costs

Supported expansion_costs spellings

tessif.frused.spellings.expansion_limits

Supported expansion_limits spellings

tessif.frused.spellings.flow_costs

Supported flow_costs spellings

tessif.frused.spellings.flow_emissions

Supported flow_emissions spellings

tessif.frused.spellings.flow_gradients

Supported flow_gradients spellings

tessif.frused.spellings.flow_rates

Supported flow_rates spellings

tessif.frused.spellings.gradient_costs

Supported gradient_costs spellings

tessif.frused.spellings.idle_changes

Supported idle_changes spellings

tessif.frused.spellings.initial_soc

Supported initial_soc spellings

tessif.frused.spellings.initial_status

Supported initial_status spellings

tessif.frused.spellings.inputs

Supported inputs spellings

tessif.frused.spellings.number_of_status_changes

Supported number_of_status_changes spellings

tessif.frused.spellings.status_inertia

Supported status_inertia spellings

tessif.frused.spellings.status_changing_costs

Supported status_changing_costs spellings

tessif.frused.spellings.outputs

Supported outputs spellings

Component Parameters as Singular Values

tessif.frused.spellings.active

Supported active spellings

tessif.frused.spellings.accumulated_maximum

Supported accumulated_maximum spellings

tessif.frused.spellings.accumulated_minimum

Supported accumulated_minimum spellings

tessif.frused.spellings.efficiency

Supported efficiency spellings

tessif.frused.spellings.emissions

Supported emissions spellings

tessif.frused.spellings.exogenously_set

Supported exogenously_set spellings

tessif.frused.spellings.exogenously_set_value

Supported exogenously_set_value spellings

tessif.frused.spellings.expansion_problem

Supported expansion_problem spellings

tessif.frused.spellings.gain_rate

Supported gain_rate spellings

tessif.frused.spellings.input

Supported input spellings

tessif.frused.spellings.installed_capacity

Supported installed_capacity spellings

tessif.frused.spellings.loss_rate

Supported loss_rate spellings

tessif.frused.spellings.maximum

Supported maximum spellings

tessif.frused.spellings.maximum_expansion

Supported maximum_expansion spellings

tessif.frused.spellings.maximum_efficiency

Supported maximum_efficiency spellings

tessif.frused.spellings.minimum

Supported minimum spellings

tessif.frused.spellings.minimum_efficiency

Supported minimum_efficiency spellings

tessif.frused.spellings.minimum_expansion

Supported minimum_expansion spellings

tessif.frused.spellings.minimum_downtime

Supported minimum_downtime spellings

tessif.frused.spellings.minimum_uptime

Supported minimum_uptime spellings

. csv-table::

file:

source/api/frused/spellings/minimum_uptime.csv

tessif.frused.spellings.negative_gradient

Supported negative_gradient spellings

tessif.frused.spellings.negative_gradient_costs

Supported negative_gradient_costs spellings

tessif.frused.spellings.output

Supported output spellings

tessif.frused.spellings.positive_gradient

Supported positive_gradient spellings

tessif.frused.spellings.positive_gradient_costs

Supported positive_gradient_costs spellings

tessif.frused.spellings.shutdown_costs

Supported shutdown_costs spellings

tessif.frused.spellings.startup_costs

Supported startup_costs spellings

tessif.frused.spellings.storage_capacity

Supported storage_capacity spellings

Singular Value Input Output Seperation

tessif.frused.spellings.inflow_costs

Supported inflow_costs spellings

tessif.frused.spellings.inflow_efficiency

Supported inflow_efficiency spellings

tessif.frused.spellings.inflow_emissions

Supported inflow_emissions spellings

tessif.frused.spellings.input_maximum

Supported input_maximum spellings

tessif.frused.spellings.input_minimum

Supported input_minimum spellings

tessif.frused.spellings.input_negative_gradient

Supported input_negative_gradient spellings

tessif.frused.spellings.input_positive_gradient

Supported input_positive_gradient spellings

tessif.frused.spellings.outflow_costs

Supported outflow_costs spellings

tessif.frused.spellings.outflow_efficiency

Supported outflow_efficiency spellings

tessif.frused.spellings.outflow_emissions

Supported outflow_emissions spellings

tessif.frused.spellings.output_maximum

Supported output_maximum spellings

tessif.frused.spellings.output_minimum

Supported output_minimum spellings

tessif.frused.spellings.output_negative_gradient

Supported output_negative_gradient spellings

tessif.frused.spellings.output_positive_gradient

Supported output_positive_gradient spellings

Component Parameters as Series Values

tessif.frused.spellings.efficiencyN

Supported efficiencyN spellings

tessif.frused.spellings.emissionsN

Supported emissionsN spellings

tessif.frused.spellings.flow_costsN

Supported flow_costsN spellings

tessif.frused.spellings.fractionN

Supported fractionN spellings

tessif.frused.spellings.inflow_costsN

Supported inflow_costsN spellings

tessif.frused.spellings.inflow_emissionsN

Supported inflow_emissionsN spellings

tessif.frused.spellings.inputN

Supported inputN spellings

tessif.frused.spellings.outflow_costsN

Supported outflow_costsN spellings

tessif.frused.spellings.outflow_emissionsN

Supported outflow_emissionsN spellings

tessif.frused.spellings.outputN

Supported outputN spellings

Oemof Specific Component Parameters

tessif.frused.spellings.already_installed

Supported already_installed spellings

tessif.frused.spellings.back_pressure

Supported back_pressure spellings

tessif.frused.spellings.fraction

Supported fraction spellings

tessif.frused.spellings.fuel_in

Supported fuel_in spellings

tessif.frused.spellings.fuelgas_losses

Supported fuelgas_losses spellings

tessif.frused.spellings.heat_costs

Supported heat_costs spellings

tessif.frused.spellings.heat_efficiency

Supported heat_efficiency spellings

tessif.frused.spellings.heat_emissions

Supported heat_emissions spellings

tessif.frused.spellings.heat_in

Supported heat_in spellings

tessif.frused.spellings.heat_out

Supported heat_out spellings

tessif.frused.spellings.ideal

Supported ideal spellings

tessif.frused.spellings.lower_heating_value

Supported lower_heating_value spellings

tessif.frused.spellings.maximum_extraction

Supported maximum_extraction spellings

tessif.frused.spellings.maximum_fuelgas_losses

Supported maximum_fuelgas_losses spellings

tessif.frused.spellings.maximum_heat

Supported maximum_heat spellings

tessif.frused.spellings.maximum_power

Supported maximum_power spellings

tessif.frused.spellings.milp

Supported milp spellings

tessif.frused.spellings.minimum_extraction

Supported minimum_extraction spellings

tessif.frused.spellings.minimum_fuelgas_losses

Supported minimum_fuelgas_losses spellings

tessif.frused.spellings.minimum_heat

Supported minimum_heat spellings

tessif.frused.spellings.minimum_power

Supported minimum_power spellings

tessif.frused.spellings.nominal_value

Supported nominal_value spellings

tessif.frused.spellings.number_of_connections

Supported number_of_connections spellings

tessif.frused.spellings.power_costs

Supported power_costs spellings

tessif.frused.spellings.power_efficiency

Supported power_efficiency spellings

tessif.frused.spellings.power_emissions

Supported power_emissions spellings

tessif.frused.spellings.power_loss_index

Supported power_loss_index spellings

tessif.frused.spellings.power_out

Supported power_out spellings

tessif.frused.spellings.upper_heating_value

Supported upper_heating_value spellings

Energy System Component Identifiers

tessif.frused.spellings.energy_system_component_identifiers

Recognized node name representations.

Energy System Component Identifers

tessif.frused.spellings.bus

Supported bus spellings

tessif.frused.spellings.sink

Supported sink spellings

tessif.frused.spellings.storage

Supported storage spellings

tessif.frused.spellings.source

Supported source spellings

tessif.frused.spellings.transformer

Supported transformer spellings

tessif.frused.spellings.connector

Supported connector spellings

Energy System Component Identifers - Energy Carrier

tessif.frused.spellings.solar

Supported solar spellings

tessif.frused.spellings.wind

Supported wind spellings

tessif.frused.spellings.water

Supported water spellings

tessif.frused.spellings.biomass

Supported biomass spellings

tessif.frused.spellings.commodity

Supported commodity spellings

tessif.frused.spellings.gas

Supported gas spellings

tessif.frused.spellings.oil

Supported oil spellings

tessif.frused.spellings.lignite

Supported lignite spellings

tessif.frused.spellings.hardcoal

Supported hardcoal spellings

tessif.frused.spellings.nuclear

Supported nuclear spellings

tessif.frused.spellings.electricity

Supported electricity spellings

tessif.frused.spellings.hot_water

Supported hot_water spellings

tessif.frused.spellings.steam

Supported steam spellings

Energy System Component Identifers - Sector

tessif.frused.spellings.power

Supported power spellings

tessif.frused.spellings.heat

Supported heat spellings

tessif.frused.spellings.mobility

Supported mobility spellings

tessif.frused.spellings.coupled

Supported coupled spellings

Energy System Component Identifers - Label

tessif.frused.spellings.renewables

Supported renewables spellings

tessif.frused.spellings.photovoltaic

Supported photovoltaic spellings

tessif.frused.spellings.solarthermal

Supported solarthermal spellings

tessif.frused.spellings.onshore

Supported onshore spellings

tessif.frused.spellings.offshore

Supported offshore spellings

tessif.frused.spellings.hydro_electric

Supported hydro_electric spellings

tessif.frused.spellings.mimo_transformer

Supported mimo_transformer spellings

tessif.frused.spellings.sito_flex_transformer

Supported sito_flex_transformer spellings

tessif.frused.spellings.generic_chp

Supported generic_chp spellings

tessif.frused.spellings.siso_nonlinear_transformer

Supported siso_nonlinear_transformer spellings

tessif.frused.spellings.combined_heat_power

Supported combined_heat_power spellings

tessif.frused.spellings.power_plant

Supported power_plant spellings

tessif.frused.spellings.heat_plant

Supported heat_plant spellings

tessif.frused.spellings.electrical_line

Supported electrical_line spellings

tessif.frused.spellings.gas_pipeline

Supported gas_pipeline spellings

tessif.frused.spellings.gas_delivery

Supported gas_delivery spellings

tessif.frused.spellings.oil_pipeline

Supported oil_pipeline spellings

tessif.frused.spellings.oil_delivery

Supported oil_delivery spellings

tessif.frused.spellings.generic_storage

Supported generic_storage spellings

tessif.frused.spellings.hydro_electrical_storage

Supported hydro_electrical_storage spellings

tessif.frused.spellings.electro_chemical_storage

Supported electro_chemical_storage spellings

tessif.frused.spellings.electro_mechanical_storage

Supported electro_mechanical_storage spellings

tessif.frused.spellings.thermal_energy_storage

Supported thermal_energy_storage spellings

tessif.frused.spellings.power2x

Supported power2x spellings

tessif.frused.spellings.imported

Supported imported spellings

tessif.frused.spellings.backup

Supported backup spellings

tessif.frused.spellings.export

Supported export spellings

tessif.frused.spellings.excess

Supported excess spellings