oemof.tabular package

Submodules

oemof.tabular.facades module

`Facade`s are classes providing a simplified view on more complex classes.

More specifically, the Facade`s in this module act as simplified, energy specific wrappers around `oemof’s and oemof.solph’s more abstract and complex classes. The idea is to be able to instantiate a Facade using keyword arguments, whose value are derived from simple, tabular data sources. Under the hood the Facade then uses these arguments to construct an oemof or oemof.solph component and sets it up to be easily used in an EnergySystem.

SPDX-License-Identifier: BSD-3-Clause

class oemof.tabular.facades.BackpressureTurbine(*args, **kwargs)[source]

Bases: oemof.solph.network.Transformer, oemof.tabular.facades.Facade

Combined Heat and Power (backpressure) unit with one input and two outputs.

Parameters:
  • electricity_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its electrical output
  • heat_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its thermal output
  • fuel_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its input
  • carrier_cost (numeric) – Input carrier cost of the backpressure unit, Default: 0
  • capacity (numeric) – The electrical capacity of the chp unit (e.g. in MW).
  • electric_efficiency – Electrical efficiency of the chp unit
  • thermal_efficiency – Thermal efficiency of the chp unit
  • marginal_cost (numeric) – Marginal cost for one unit of produced electrical output E.g. for a powerplant: marginal cost =fuel cost + operational cost + co2 cost (in Euro / MWh) if timestep length is one hour. Default: 0
  • capacity_cost (numeric) – Investment costs per unit of electrical capacity (e.g. Euro / MW) . If capacity is not set, this value will be used for optimizing the chp capacity.
build_solph_components()[source]
class oemof.tabular.facades.Conversion(*args, **kwargs)[source]

Bases: oemof.solph.network.Transformer, oemof.tabular.facades.Facade

Conversion unit with one input and one output.

Parameters:
  • from_bus (oemof.solph.Bus) – An oemof bus instance where the conversion unit is connected to with its input.
  • to_bus (oemof.solph.Bus) – An oemof bus instance where the conversion unit is connected to with its output.
  • capacity (numeric) – The conversion capacity (output side) of the unit.
  • efficiency (numeric) – Efficiency of the conversion unit (0 <= efficiency <= 1). Default: 1
  • marginal_cost (numeric) – Marginal cost for one unit of produced output. Default: 0
  • capacity_cost (numeric) – Investment costs per unit of output capacity. If capacity is not set, this value will be used for optimizing the conversion output capacity.
  • input_parameters (dict (optional)) – Set parameters on the input edge of the storage (see oemof.solph for more information on possible parameters)
  • ouput_parameters (dict (optional)) – Set parameters on the output edge of the storage (see oemof.solph for more information on possible parameters)
build_solph_components()[source]
class oemof.tabular.facades.Dispatchable(*args, **kwargs)[source]

Bases: oemof.solph.network.Source, oemof.tabular.facades.Facade

Dispatchable element with one output for example a gas-turbine

Parameters:
  • bus (oemof.solph.Bus) – An oemof bus instance where the unit is connected to with its output
  • capacity (numeric) – The installed power of the generator (e.g. in MW). If not set the capacity will be optimized (s. also capacity_cost argument)
  • profile (array-like (optional)) – Profile of the output such that profile[t] * installed yields output for timestep t
  • marginal_cost (numeric) – Marginal cost for one unit of produced output, i.e. for a powerplant: mc = fuel_cost + co2_cost + … (in Euro / MWh) if timestep length is one hour. Default: 0
  • capacity_cost (numeric (optional)) – Investment costs per unit of capacity (e.g. Euro / MW) . If capacity is not set, this value will be used for optimizing the generators capacity.
  • output_paramerters (dict (optional)) – Parameters to set on the output edge of the component (see. oemof.solph Edge/Flow class for possible arguments)
  • capacity_potential (numeric) – Max install capacity if capacity is to be optimized
build_solph_components()[source]
class oemof.tabular.facades.Excess(*args, **kwargs)[source]

Bases: oemof.solph.network.Sink, oemof.tabular.facades.Facade

class oemof.tabular.facades.ExtractionTurbine(*args, **kwargs)[source]

Bases: oemof.solph.components.ExtractionTurbineCHP, oemof.tabular.facades.Facade

Combined Heat and Power (extraction) unit with one input and two outputs.

Parameters:
  • electricity_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its electrical output
  • heat_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its thermal output
  • fuel_bus (oemof.solph.Bus) – An oemof bus instance where the chp unit is connected to with its input
  • carrier_cost (numeric) – Cost per unit of used input carrier
  • capacity (numeric) – The electrical capacity of the chp unit (e.g. in MW) in full extraction mode.
  • electric_efficiency – Electrical efficiency of the chp unit in full backpressure mode
  • thermal_efficiency – Thermal efficiency of the chp unit in full backpressure mode
  • condensing_efficiency – Electrical efficiency if turbine operates in full extraction mode
  • marginal_cost (numeric) – Marginal cost for one unit of produced electrical output E.g. for a powerplant: marginal cost =fuel cost + operational cost + co2 cost (in Euro / MWh) if timestep length is one hour.
  • capacity_cost (numeric) – Investment costs per unit of electrical capacity (e.g. Euro / MW) . If capacity is not set, this value will be used for optimizing the chp capacity.
build_solph_components()[source]
class oemof.tabular.facades.Facade(*args, **kwargs)[source]

Bases: oemof.network.Node

Parameters:_facade_requires_ (list of str) – A list of required attributes. The constructor checks whether these are present as keywort arguments or whether they are already present on self (which means they have been set by constructors of subclasses) and raises an error if he doesn’t find them.
update()[source]
class oemof.tabular.facades.Generator(*args, **kwargs)[source]

Bases: oemof.tabular.facades.Dispatchable

Bases: oemof.solph.custom.Link, oemof.tabular.facades.Facade

Bi-direction link for two buses (e.g. to model transshipment)

Parameters:
  • from_bus (oemof.solph.Bus) – An oemof bus instance where the link unit is connected to with its input.
  • to_bus (oemof.solph.Bus) – An oemof bus instance where the link unit is connected to with its output.
  • capacity (numeric) – The maximal capacity (output side each) of the unit. If not set, attr capacity_cost needs to be set.
  • loss – Relative loss through the link (default: 0)
  • capacity_cost (numeric) – Investment costs per unit of output capacity. If capacity is not set, this value will be used for optimizing the chp capacity.
build_solph_components()[source]
class oemof.tabular.facades.Load(*args, **kwargs)[source]

Bases: oemof.solph.network.Sink, oemof.tabular.facades.Facade

Load object with one input

Parameters:
  • bus (oemof.solph.Bus) – An oemof bus instance where the demand is connected to.
  • amount (numeric) – The total amount for the timehorzion (e.g. in MWh)
  • profile (array-like) – Load profile with normed values such that profile[t] * amount yields the load in timestep t (e.g. in MWh)
  • input_parameters (dirct (optional))
build_solph_components()[source]
class oemof.tabular.facades.Reservoir(*args, **kwargs)[source]

Bases: oemof.solph.components.GenericStorage, oemof.tabular.facades.Facade

A Reservoir storage unit, that is initially half full.

Note that the investment option is not available for this facade at the current development state.

Parameters:
  • bus (oemof.solph.Bus) – An oemof bus instance where the storage unit is connected to.
  • storage_capacity (numeric) – The total storage capacity of the storage (e.g. in MWh)
  • capacity (numeric) – Installed production capacity of the turbine installed at the reservoir
  • efficiency (numeric) – Efficiency of the turbine converting inflow to electricity production, default: 1
  • profile (array-like) – Absolute profile of inflow into the storage
  • input_parameters (dict) – Dictionary to specifiy parameters on the input edge. You can use all keys that are available for the oemof.solph.network.Flow class.
  • output_parameters (dict) – see: input_parameters
build_solph_components()[source]
class oemof.tabular.facades.Shortage(*args, **kwargs)[source]

Bases: oemof.tabular.facades.Dispatchable

class oemof.tabular.facades.Storage(*args, **kwargs)[source]

Bases: oemof.solph.components.GenericStorage, oemof.tabular.facades.Facade

Storage unit

Parameters:
  • bus (oemof.solph.Bus) – An oemof bus instance where the storage unit is connected to.
  • storage_capacity (numeric) – The total capacity of the storage (e.g. in MWh)
  • capacity (numeric) – Maximum production capacity (e.g. in MW)
  • capacity_ratio (numeric) – Ratio between storage_capacity and capacity
  • efficiency (numeric) – Efficiency of charging and discharging process: Default: 1
  • capacity_cost (numeric) – Investment costs for the storage unit e.g in €/MW-capacity
  • loss (numeric) – Standing loss per timestep in % of capacity. Default: 0
  • storage_capacity_initial (numeric) – The state of the storage capacity in the first (and last) time step of optimization. Default: 0.5
  • input_parameters (dict (optional)) – Set parameters on the input edge of the storage (see oemof.solph for more information on possible parameters)
  • ouput_parameters (dict (optional)) – Set parameters on the output edge of the storage (see oemof.solph for more information on possible parameters)
build_solph_components()[source]
class oemof.tabular.facades.Volatile(*args, **kwargs)[source]

Bases: oemof.solph.network.Source, oemof.tabular.facades.Facade

Volatile element with one output, for example a wind turbine

Parameters:
  • bus (oemof.solph.Bus) – An oemof bus instance where the generator is connected to
  • capacity (numeric) – The installed power of the unit (e.g. in MW).
  • profile (array-like) – Profile of the output such that profile[t] * capacity yields output for timestep t
  • marginal_cost (numeric) – Marginal cost for one unit of produced output, i.e. for a powerplant: mc = fuel_cost + co2_cost + … (in Euro / MWh) if timestep length is one hour.
  • capacity_cost (numeric (optional)) – Investment costs per unit of capacity (e.g. Euro / MW) . If capacity is not set, this value will be used for optimizing the generators capacity.
  • output_paramerters (dict (optional)) – Parameters to set on the output edge of the component (see. oemof.solph Edge/Flow class for possible arguments)
  • capacity_potential (numeric) – Max install capacity if investment
build_solph_components()[source]