oemof.core.network.entities.components package


oemof.core.network.entities.components.sinks module

class oemof.core.network.entities.components.sinks.Simple(**kwargs)[source]

Bases: oemof.core.network.entities.components.Sink

A simple sink. Use this if you do not know which sink to use.

optimization_options = {}

oemof.core.network.entities.components.sources module

class oemof.core.network.entities.components.sources.Commodity(**kwargs)[source]

Bases: oemof.core.network.entities.components.Source

The commodity component can be used to model inputs to resource busses. At the moment no constraint etc. are implemented for this component.

optimization_options = {}
class oemof.core.network.entities.components.sources.DispatchSource(**kwargs)[source]

Bases: oemof.core.network.entities.components.Source

Dispatch sources only have one output (like FixedSource) but the output can be reduced inside the optimization problem.

optimization_options = {}
class oemof.core.network.entities.components.sources.FixedSource(**kwargs)[source]

Bases: oemof.core.network.entities.components.Source

A fixed source only has one output always. The value of the output is fixed for all timesteps in the timehorizon of the optimization problem.

optimization_options = {}

oemof.core.network.entities.components.transformers module

class oemof.core.network.entities.components.transformers.CHP(**kwargs)[source]

Bases: oemof.core.network.entities.components.Transformer

A CombinedHeatPower Transformer always has a simple input output relation with a constant efficiency

Parameters:eta (list) – constant effciency for converting input into output. First element of list is used for conversion of input into first element of attribute outputs. Second element for second element of attribute outputs. E.g. eta = [0.3, 0.4]
optimization_options = {}
class oemof.core.network.entities.components.transformers.Simple(**kwargs)[source]

Bases: oemof.core.network.entities.components.Transformer

Simple Transformers always have a simple input output relation with a constant efficiency

Parameters:eta (list) – constant efficiency for conversion of input into output (0 <= eta <= 1) e.g. eta = [0.4]
optimization_options = {}
class oemof.core.network.entities.components.transformers.SimpleExtractionCHP(**kwargs)[source]

Bases: oemof.core.network.entities.components.transformers.CHP

Class for combined heat and power unit with extraction turbine and constant power to heat coeffcient in backpressure mode

  • eta_el_cond (float) – constant el. efficiency for transformer in condensing mode
  • beta (float) – power loss index
  • sigma (float) – power to heat ratio P/Q in backpressure mode
optimization_options = {}
class oemof.core.network.entities.components.transformers.Storage(**kwargs)[source]

Bases: oemof.core.network.entities.components.Transformer

  • cap_max (float) – absolut maximum state of charge if invest=FALSE, absolut maximum state of charge of built capacity if invest=TRUE
  • cap_min (float) – absolut minimum state of charge
  • cap_initial (float, optional) – The state of charge (soc) at timestep 0.
  • add_cap_limit (float) – limit of additional installed capacity (only investment models)
  • eta (list (optional)) – constant efficiency for charging, discharging input e.g. eta = [0.9, 0.9]
  • eta_in (float) – efficiency at charging
  • eta_out (float) – efficiency at discharging
  • cap_loss (float or list/pandas.Series with length of simulation timesteps) – capacity loss per timestep in p/100
  • c_rate_in (float) – c-rate for charging (unit is s^-1)
  • c_rate_out (float) – c-rate for discharging (unit is s^-1)
optimization_options = {}
class oemof.core.network.entities.components.transformers.TwoInputsOneOutput(**kwargs)[source]

Bases: oemof.core.network.entities.components.transformers.Simple

A transformer with one output and two input flows

The two input flows are connect by the factor f. This transformer might represent components such as heat pumps and instant flow heater.

  • eta (list) – Constant effciency for converting the incoming flows to the internal input flows. The first element of eta is the efficiency of the first element of inputs and so on. If not set the effciency will be one. You have to define both elements or no element.
  • f (array-like) – A relation-factor between the first and the second input flow.
class oemof.core.network.entities.components.transformers.VariableEfficiencyCHP(**kwargs)[source]

Bases: oemof.core.network.entities.components.transformers.CHP

A CombinedHeatPower Transformer with variable electrical efficiency Note: The model uses constraints which require binary variables, hence objects of this class will results in mixed-integer-linear-problems.

  • eta_total (float) – total constant efficiency for the transformer
  • eta_el (list) – list containing the minimial (first element) and maximal (second element) electrical efficiency (0 <= eta_el <= 1)
optimization_options = {}

oemof.core.network.entities.components.transports module

class oemof.core.network.entities.components.transports.Simple(**kwargs)[source]

Bases: oemof.core.network.entities.components.Transport

Simple Transport connects two busses with a constant efficiency

  • eta (float) – Constant efficiency of the transport.
  • in_max (float) – Maximum input the transport can handle, in $MW$.
  • out_max (float) – Maximum output which can possibly be obtained when using the transport, in $MW$.
optimization_options = {}

Module contents

class oemof.core.network.entities.components.Sink(**kwargs)[source]

Bases: oemof.core.network.entities.Component

A Sink is special Component which only consumes some source commodity. Therefore its list of outputs has to be either None or empty (i.e. logically False).

class oemof.core.network.entities.components.Source(**kwargs)[source]

Bases: oemof.core.network.entities.Component

The opposite of a Sink, i.e. a Component which only produces and as a consequence has no input.

  • in_max (list) – maximum input of component (e.g. in MW)
  • out_max (list) – maximum output of component (e.g. in MW)
  • add_out_limit (float) – limit on additional output “capacity” (e.g. in MW)
  • capex (float) – capital expenditure (e.g. in Euro / MW )
  • lifetime (float) – lifetime of component (e.g. years)
  • wacc (float) – weigted average cost of capital (dimensionless)
  • crf (float) – capital recovery factor: (p*(1+p)^n)/(((1+p)^n)-1)
  • opex_fix (float) – fixed operational expenditure (e.g. expenses for staff)
  • opex_var (float) – variable operational expenditure (e.g. spare parts + fuelcosts)
  • co2_fix (float) – fixed co2 emissions (e.g. t / MW)
  • co2_var (float) – variable co2 emissions (e.g. t / MWh)
  • co2_cap (float) – co2 emissions due to installed power (e.g. t/ MW)
optimization_options = {}
class oemof.core.network.entities.components.Transformer(**kwargs)[source]

Bases: oemof.core.network.entities.Component

A Transformer is a specific type of Component which transforms (possibly m) inputs into (possibly n) outputs. As such neither its list of inputs, nor its list of outputs are allowed to be empty.

  • out_min (list) – minimal output of transformer (e.g. min power output of powerplants)
  • in_min (list) – minimal input of transformer (e.g. min fuel consumption of powerplants)
  • grad_pos (float) – positive gradient (absolut value between two sequential timesteps)
  • grad_neg (float) – negative gradient (absolut value between two sequential timesteps)
  • t_min_off (float) – minimal off time in timesteps (e.g. 5 hours)
  • t_min_on (float) – minimal on time in timesteps (e.g 5 hours)
  • outages (float or array) – Outages of component. either: defined timesteps of timehorizon: e.g. [1,4,200] or: 0 <= scalar <= 1 as factor of the total timehorizon e.g. 0.05
  • input_costs (float) – costs for usage of input (if not included in opex_var)
  • start_costs (float) – cost per start up of transformer (only milp models)
  • stop_costs (float) – cost per stop up of transformer (only milp models)
  • ramp_costs (float) – costs for ramping
  • output_price (list) – price for selling to output bus. prices ordered in the order of ‘outputs’
  • eta_min (list) – efficiency of transformer at minimum load for conversion of input to output (order of elements corresponding to order of elements out outputs,out_min etc.)
optimization_options = {}
class oemof.core.network.entities.components.Transport(**kwargs)[source]

Bases: oemof.core.network.entities.Component

A Transport is a simple connection transporting a commodity from one Bus to a different one. It is different from a Transformer in that it may not change the type of commodity being transported. But since the transfer can still change things about the commodity other than the type (loss, gain, time delay, etc.) this class exists to encapsulate such changes.

optimization_options = {}