edisgo.network.components¶

Classes¶

`BasicComponent`	Generic component
`Component`	Generic component for all components that can be considered nodes,
`Load`	Load object
`Generator`	Generator object
`Storage`	Storage object
`Switch`	Switch object
`PotentialChargingParks`	Generic component

Module Contents¶

class edisgo.network.components.BasicComponent(**kwargs)[source]¶

Bases: abc.ABC

digraph inheritance2c85fe737c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Generic component

Can be initialized with EDisGo object or Topology object. In case of Topology object component time series attributes currently will raise an error.

property id¶

Unique identifier of component as used in component dataframes in Topology.

Returns:: Unique identifier of component.
Return type:: str

property edisgo_obj¶

EDisGo container

Return type:: EDisGo

property topology¶

Network topology container

Return type:: Topology

property voltage_level¶

Voltage level the component is connected to (‘mv’ or ‘lv’).

Returns:: Voltage level. Returns ‘lv’ if component connected to the low voltage and ‘mv’ if component is connected to the medium voltage.
Return type:: str

abstract property grid¶

Grid component is in.

Returns:: Grid component is in.
Return type:: Grid

__repr__()[source]¶

class edisgo.network.components.Component(**kwargs)[source]¶

Bases: BasicComponent

digraph inheritance7f33465dc0 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Component" [URL="#edisgo.network.components.Component",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component for all components that can be considered nodes,"]; "BasicComponent" -> "Component" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Generic component for all components that can be considered nodes, e.g. generators and loads.

property bus¶

Bus component is connected to.

Parameters:: bus (str) – ID of bus to connect component to.
Returns:: Bus component is connected to.
Return type:: str

property grid¶

Grid the component is in.

Returns:: Grid object the component is in.
Return type:: Grid

property geom¶

Geolocation of component.

Return type:: shapely.Point

__repr__()[source]¶

class edisgo.network.components.Load(**kwargs)[source]¶

Bases: Component

digraph inheritance3a88b544af { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Component" [URL="#edisgo.network.components.Component",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component for all components that can be considered nodes,"]; "BasicComponent" -> "Component" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Load" [URL="#edisgo.network.components.Load",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Load object"]; "Component" -> "Load" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Load object

property p_set¶

Peak load in MW.

Parameters:: p_set (float) – Peak load in MW.
Returns:: Peak load in MW.
Return type:: float

property annual_consumption¶

Annual consumption of load in MWh.

Parameters:: annual_consumption (float) – Annual consumption in MWh.
Returns:: Annual consumption of load in MWh.
Return type:: float

property sector¶

Sector load is associated with.

The sector is e.g. used to assign load time series to a load using the demandlib. The following four sectors are considered: ‘agricultural’, ‘cts’, ‘residential’, ‘industrial’.

Parameters:

sector (str)

Returns:

str – Load sector
#ToDo (Maybe return ‘not specified’ in case sector is None?)

property active_power_timeseries¶

Active power time series of load in MW.

Returns:: Active power time series of load in MW.
Return type:: pandas.Series

property reactive_power_timeseries¶

Reactive power time series of load in Mvar.

Returns:: Reactive power time series of load in Mvar.
Return type:: pandas.Series

class edisgo.network.components.Generator(**kwargs)[source]¶

Bases: Component

digraph inheritancec4dc9c512f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Component" [URL="#edisgo.network.components.Component",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component for all components that can be considered nodes,"]; "BasicComponent" -> "Component" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Generator" [URL="#edisgo.network.components.Generator",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generator object"]; "Component" -> "Generator" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Generator object

property nominal_power¶

Nominal power of generator in MW.

Parameters:: nominal_power (float) – Nominal power of generator in MW.
Returns:: Nominal power of generator in MW.
Return type:: float

property type¶

Technology type of generator (e.g. ‘solar’).

Parameters:

type (str)

Returns:

str – Technology type
#ToDo (Maybe return ‘not specified’ in case type is None?)

property subtype¶

Technology subtype of generator (e.g. ‘solar_roof_mounted’).

Parameters:

subtype (str)

Returns:

str – Technology subtype
#ToDo (Maybe return ‘not specified’ in case subtype is None?)

property active_power_timeseries¶

Active power time series of generator in MW.

Returns:: Active power time series of generator in MW.
Return type:: pandas.Series

property reactive_power_timeseries¶

Reactive power time series of generator in Mvar.

Returns:: Reactive power time series of generator in Mvar.
Return type:: pandas.Series

property weather_cell_id¶

Weather cell ID of generator.

The weather cell ID is only used to obtain generator feed-in time series for solar and wind generators.

Parameters:: weather_cell_id (int) – Weather cell ID of generator.
Returns:: Weather cell ID of generator.
Return type:: int

class edisgo.network.components.Storage(**kwargs)[source]¶

Bases: Component

digraph inheritance892fd3b7a8 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Component" [URL="#edisgo.network.components.Component",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component for all components that can be considered nodes,"]; "BasicComponent" -> "Component" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Storage" [URL="#edisgo.network.components.Storage",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Storage object"]; "Component" -> "Storage" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Storage object

property nominal_power¶

Nominal power of storage unit in MW.

Parameters:: nominal_power (float) – Nominal power of storage unit in MW.
Returns:: Nominal power of storage unit in MW.
Return type:: float

property active_power_timeseries¶

Active power time series of storage unit in MW.

Returns:: Active power time series of storage unit in MW.
Return type:: pandas.Series

property reactive_power_timeseries¶

Reactive power time series of storage unit in Mvar.

Returns:: Reactive power time series of storage unit in Mvar.
Return type:: pandas.Series

property state_of_charge_timeseries¶

State of charge time series of storage unit in MWh.

Returns:: State of charge time series of storage unit in MWh.
Return type:: pandas.Series

__repr__()[source]¶

class edisgo.network.components.Switch(**kwargs)[source]¶

Bases: BasicComponent

digraph inheritance056be3d9c9 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Switch" [URL="#edisgo.network.components.Switch",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Switch object"]; "BasicComponent" -> "Switch" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Switch object

Switches are for example medium voltage disconnecting points (points where MV rings are split under normal operation conditions). They are represented as branches and can have two states: ‘open’ or ‘closed’. When the switch is open the branch it is represented by connects some bus and the bus specified in bus_open. When it is closed bus bus_open is substitued by the bus specified in bus_closed.

property type¶

Type of switch.

So far edisgo only considers switch disconnectors.

Parameters:: type (str) – Type of switch.
Returns:: Type of switch.
Return type:: str

property bus_open¶

Bus ID of bus the switch is ‘connected’ to when state is ‘open’.

As switches are represented as branches they connect two buses. bus_open specifies the bus the branch is connected to in the open state.

Returns:: Bus in ‘open’ state.
Return type:: str

property bus_closed¶

Bus ID of bus the switch is ‘connected’ to when state is ‘closed’.

As switches are represented as branches they connect two buses. bus_closed specifies the bus the branch is connected to in the closed state.

Returns:: Bus in ‘closed’ state.
Return type:: str

property state¶

State of switch (open or closed).

Returns:: State of switch: ‘open’ or ‘closed’.
Return type:: str

property branch¶

Branch the switch is represented by.

Returns:: Branch the switch is represented by.
Return type:: str

property grid¶

Grid switch is in.

Returns:: Grid switch is in.
Return type:: Grid

open()[source]¶: Open switch.

close()[source]¶: Close switch.

class edisgo.network.components.PotentialChargingParks(**kwargs)[source]¶

Bases: BasicComponent

digraph inheritance60c3a1c72b { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Helper class that provides a standard way to create an ABC using"]; "BasicComponent" [URL="#edisgo.network.components.BasicComponent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Generic component"]; "ABC" -> "BasicComponent" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PotentialChargingParks" [URL="#edisgo.network.components.PotentialChargingParks",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BasicComponent" -> "PotentialChargingParks" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Generic component

Can be initialized with EDisGo object or Topology object. In case of Topology object component time series attributes currently will raise an error.

property voltage_level¶

Voltage level the component is connected to (‘mv’ or ‘lv’).

Returns:: Voltage level. Returns ‘lv’ if component connected to the low voltage and ‘mv’ if component is connected to the medium voltage.
Return type:: str

property grid¶

Grid component is in.

Returns:: Grid component is in.
Return type:: Grid

property ags¶

8-digit AGS (Amtlicher Gemeindeschlüssel, eng. Community Identification Number) number the potential charging park is in. Number is given as int and leading zeros are therefore missing.

Returns:: AGS number
Return type:: int

property use_case¶

Charging use case (home, work, public or hpc) of the potential charging park.

Returns:: Charging use case
Return type:: str

property designated_charging_point_capacity¶

Total gross designated charging park capacity in kW.

This is not necessarily equal to the connection rating.

Returns:: Total gross designated charging park capacity
Return type:: float

property user_centric_weight¶

User centric weight of the potential charging park determined by SimBEV.

Returns:: User centric weight
Return type:: float

property geometry¶

Location of the potential charging park as Shapely Point object.

Returns:: Location of the potential charging park.
Return type:: Shapely Point object.

property nearest_substation¶

Determines the nearest LV Grid, substation and distance.

Returns:

int: LV Grid ID
str: ID of the nearest substation
float: Distance to nearest substation

Return type:

dict

property edisgo_id¶

property charging_processes_df¶

Determines designated charging processes for the potential charging park.

Returns:: DataFrame with AGS, car ID, trip destination, charging use case (private or public), netto charging capacity, charging demand, charge start, charge end, potential charging park ID and charging point ID.
Return type:: pandas.DataFrame

property grid_connection_capacity¶

property within_grid¶: Determines if the potential charging park is located within the grid district.