VeraGridEngine.Devices.Aggregation package

Submodules

VeraGridEngine.Devices.Aggregation.area module

class VeraGridEngine.Devices.Aggregation.area.Area(name: str = 'Area', idtag: str | None = None, code: str = '', latitude=0.0, longitude=0.0)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

color

class VeraGridEngine.Devices.Aggregation.area.GenericAreaGroup(name='', code='', idtag: str | None = None, device_type=Generic Area, latitude=0.0, longitude=0.0, color: str | None = None)

Bases: EditableDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:longitude, prop:latitude, prop:color)

color

property latitude: float

Get latitude.

Returns:

float

property longitude: float

Get longitude.

Returns:

float

VeraGridEngine.Devices.Aggregation.branch_group module

class VeraGridEngine.Devices.Aggregation.branch_group.BranchGroup(name='', code='', idtag: str | None = None, group_type: BranchGroupTypes = Generic group, color: str | None = None)

Bases: EditableDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:group_type, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:group_type, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'group_type': prop:group_type, 'idtag': prop:idtag, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:group_type, prop:color)

color

property group_type: BranchGroupTypes

Type of branch group :return: BranchGroupTypes

VeraGridEngine.Devices.Aggregation.community module

class VeraGridEngine.Devices.Aggregation.community.Community(name='Country', idtag: str | None = None, code='', latitude=0.0, longitude=0.0, country: Country | None = None)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:country)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:country)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'country': prop:country, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:country,)

country: Country | None

VeraGridEngine.Devices.Aggregation.country module

class VeraGridEngine.Devices.Aggregation.country.Country(name='Country', idtag: str | None = None, code='', latitude=0.0, longitude=0.0)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

color

VeraGridEngine.Devices.Aggregation.facility module

class VeraGridEngine.Devices.Aggregation.facility.Facility(name='', code='', idtag: str | None = None, latitude=0.0, longitude=0.0)

Bases: GenericAreaGroup

This is an aggregation of Injection devices

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

color

VeraGridEngine.Devices.Aggregation.inter_aggregation_info module

class VeraGridEngine.Devices.Aggregation.inter_aggregation_info.InterAggregationInfo(valid: bool, lst_from: List[Tuple[int, Bus]], lst_to: List[Tuple[int, Bus]], lst_br: List[Tuple[int, BRANCH_TYPES, float]], lst_br_hvdc: List[Tuple[int, HvdcLine, float]], objects_from: List[Area | Zone | Country], objects_to: List[Area | Zone | Country], logger: Logger = <VeraGridEngine.basic_structures.Logger object>)

Bases: EditableDevice

Class to store information of inter area, inter country, etc

CLASS_NON_EDITABLE_PROPERTIES = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE = {}

CLASS_PROPERTY_DECLARATIONS = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes)

CLASS_PROPERTY_LIST = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes)

CLASS_REGISTERED_PROPERTIES = {'action': prop:action, 'code': prop:code, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'name': prop:name, 'rdfid': prop:rdfid}

property idx_branches: ndarray[tuple[Any, ...], dtype[int64]]

Get array of tie-branches indices :return: IntVec

property idx_bus_from: ndarray[tuple[Any, ...], dtype[int64]]

Get bus of the aggregation “from” indices :return: IntVec

property idx_bus_to: ndarray[tuple[Any, ...], dtype[int64]]

Get bus of the aggregation “to” indices :return: IntVec

property idx_hvdc: ndarray[tuple[Any, ...], dtype[int64]]

Returns:

is_from(bus_idx: int) → bool

check if a bus index belongs to the “from” set :param bus_idx: bus index :return: true / false

is_to(bus_idx: int) → bool

check if a bus index belongs to the “to” set :param bus_idx: bus index :return: true / false

logger

lst_br: List[Tuple[int, BRANCH_TYPES, float]]

lst_br_hvdc

lst_from: List[Tuple[int, Bus]]

lst_to: List[Tuple[int, Bus]]

objects_from: List[Area | Zone | Country]

objects_to: List[Area | Zone | Country]

property sense_branches: ndarray[tuple[Any, ...], dtype[float64]]

Get array of tie-branch sense values (1 for from->to, -1 for to->from) :return: IntVec

property sense_hvdc: ndarray[tuple[Any, ...], dtype[float64]]

Returns:

set_bus_idx_from: Set[int]

set_bus_idx_to: Set[int]

valid: float

VeraGridEngine.Devices.Aggregation.investment module

class VeraGridEngine.Devices.Aggregation.investment.Investment

Bases: PointerDeviceParent

property CAPEX: float

Get CAPEX.

Returns:

float

CLASS_NON_EDITABLE_PROPERTIES = ('idtag', 'diff_changes', 'device_idtag', 'tpe', 'device_name')

CLASS_PROPERTIES_WITH_PROFILE = {}

CLASS_PROPERTY_DECLARATIONS = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:device_idtag, prop:tpe, prop:device_name, prop:CAPEX, prop:status, prop:group, prop:commissioning_date, prop:decommissioning_date, prop:prop, prop:value)

CLASS_PROPERTY_LIST = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:device_idtag, prop:tpe, prop:device_name, prop:CAPEX, prop:status, prop:group, prop:commissioning_date, prop:decommissioning_date, prop:prop, prop:value)

CLASS_REGISTERED_PROPERTIES = {'CAPEX': prop:CAPEX, 'action': prop:action, 'code': prop:code, 'comment': prop:comment, 'commissioning_date': prop:commissioning_date, 'decommissioning_date': prop:decommissioning_date, 'device_idtag': prop:device_idtag, 'device_name': prop:device_name, 'diff_changes': prop:diff_changes, 'group': prop:group, 'idtag': prop:idtag, 'name': prop:name, 'prop': prop:prop, 'rdfid': prop:rdfid, 'status': prop:status, 'tpe': prop:tpe, 'value': prop:value}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:CAPEX, prop:status, prop:group, prop:commissioning_date, prop:decommissioning_date, prop:prop, prop:value)

property category: str

Display the group category :return:

property commissioning_date: float

Get status.

Returns:

bool

property decommissioning_date: float

Get status.

Returns:

bool

property group: InvestmentsGroup | None

Group of investments :return:

property prop: str

Get status.

Returns:

bool

property status: bool

Get status.

Returns:

bool

property value: float

Get status.

Returns:

bool

VeraGridEngine.Devices.Aggregation.investments_group module

class VeraGridEngine.Devices.Aggregation.investments_group.InvestmentsGroup(idtag: str | None = None, name: str = 'InvestmentGroup', category: str = '', comment: str = '', discount_rate: float = 5.0, CAPEX: float = 0, color: str | None = None)

Bases: EditableDevice

Investments group

property CAPEX: float

Get CAPEX.

Returns:

float

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:category, prop:discount_rate, prop:CAPEX, prop:color)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:category, prop:discount_rate, prop:CAPEX, prop:color)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'CAPEX': prop:CAPEX, 'action': prop:action, 'category': prop:category, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'discount_rate': prop:discount_rate, 'idtag': prop:idtag, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:category, prop:discount_rate, prop:CAPEX, prop:color)

category: str

color

property discount_rate: float

Get discount_rate.

Returns:

float

VeraGridEngine.Devices.Aggregation.modelling_authority module

class VeraGridEngine.Devices.Aggregation.modelling_authority.ModellingAuthority(name='', code='', idtag: str | None = None)

Bases: EditableDevice

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'name': prop:name, 'rdfid': prop:rdfid}

action: ActionType

comment: str

device_type: DeviceType

diff_changes

selected_to_merge

VeraGridEngine.Devices.Aggregation.municipality module

class VeraGridEngine.Devices.Aggregation.municipality.Municipality(name='Municipality', idtag: str | None = None, code='', latitude=0.0, longitude=0.0, region: Region | None = None)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:region)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:region)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid, 'region': prop:region}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:region,)

region: Region | None

VeraGridEngine.Devices.Aggregation.region module

class VeraGridEngine.Devices.Aggregation.region.Region(name='Region', idtag: str | None = None, code='', latitude=0.0, longitude=0.0, community: Community | None = None)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:community)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:community)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'community': prop:community, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:community,)

community: Community | None

VeraGridEngine.Devices.Aggregation.zone module

class VeraGridEngine.Devices.Aggregation.zone.Zone(name='Zone', idtag: str | None = None, code='', latitude=0.0, longitude=0.0, area: Area | None = None)

Bases: GenericAreaGroup

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:area)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:longitude, prop:latitude, prop:color, prop:area)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'area': prop:area, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'name': prop:name, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:area,)

area: Area | None

Module contents