Content Comparison

Subpackages

Submodules

integralpy.connect module

integralpy.grid module

Anchor
integralpy.grid.BaseLoadFlowStatus integralpy.grid.BaseLoadFlowStatus

class integralpy.grid.BaseLoadFlowStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehler integralpy.grid.BaseLoadFlowStatus.enbfehler

enbfehler = 1

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerausfall integralpy.grid.BaseLoadFlowStatus.enbfehlerausfall

enbfehlerausfall = 3

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerflred integralpy.grid.BaseLoadFlowStatus.enbfehlerflred

enbfehlerflred = 10

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlergrundfall integralpy.grid.BaseLoadFlowStatus.enbfehlergrundfall

enbfehlergrundfall = 2

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerkeineredf integralpy.grid.BaseLoadFlowStatus.enbfehlerkeineredf

enbfehlerkeineredf = 7

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerkeineredkn integralpy.grid.BaseLoadFlowStatus.enbfehlerkeineredkn

enbfehlerkeineredkn = 8

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerkeinesit integralpy.grid.BaseLoadFlowStatus.enbfehlerkeinesit

enbfehlerkeinesit = 4

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerksred integralpy.grid.BaseLoadFlowStatus.enbfehlerksred

enbfehlerksred = 11

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerpmax integralpy.grid.BaseLoadFlowStatus.enbfehlerpmax

enbfehlerpmax = 12

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerpvpq integralpy.grid.BaseLoadFlowStatus.enbfehlerpvpq

enbfehlerpvpq = 6

Anchor
integralpy.grid.BaseLoadFlowStatus.enbfehlerza integralpy.grid.BaseLoadFlowStatus.enbfehlerza

enbfehlerza = 5

Anchor
integralpy.grid.BaseLoadFlowStatus.enbgekilled integralpy.grid.BaseLoadFlowStatus.enbgekilled

enbgekilled = 13

Anchor
integralpy.grid.BaseLoadFlowStatus.enbinstabil integralpy.grid.BaseLoadFlowStatus.enbinstabil

enbinstabil = 14

Anchor
integralpy.grid.BaseLoadFlowStatus.enbnnf_prf_max integralpy.grid.BaseLoadFlowStatus.enbnnf_prf_max

enbnnf_prf_max = 1100

Anchor
integralpy.grid.BaseLoadFlowStatus.enbnnf_prf_min integralpy.grid.BaseLoadFlowStatus.enbnnf_prf_min

enbnnf_prf_min = 1000

Anchor
integralpy.grid.BaseLoadFlowStatus.enbok integralpy.grid.BaseLoadFlowStatus.enbok

enbok = 0

Anchor
integralpy.grid.BaseLoadFlowStatus.enbshm_under integralpy.grid.BaseLoadFlowStatus.enbshm_under

enbshm_under = 15

Anchor
integralpy.grid.BaseLoadFlowStatus.enbstunbekannt integralpy.grid.BaseLoadFlowStatus.enbstunbekannt

enbstunbekannt = 99999999

Anchor
integralpy.grid.BaseLoadFlowStatus.enbwarnpseudomessung integralpy.grid.BaseLoadFlowStatus.enbwarnpseudomessung

enbwarnpseudomessung = 9

integralpy.session module

Anchor
integralpy.session.handle_absolute_and_relative_path integralpy.session.handle_absolute_and_relative_path

integralpy.session.handle_absolute_and_relative_path(path: str) -> str

Module contents

Anchor
integralpy.Grid integralpy.Grid

class integralpy.Grid(channel)

Bases: object

Anchor
integralpy.Grid.calculate_base_load_flow integralpy.Grid.calculate_base_load_flow

calculate_base_load_flow()

Starts Grundlastfluss calculation.

Anchor
integralpy.Grid.create integralpy.Grid.create

create(type)

Creates a new object of given type and returns the object.

Parameters

type : single integralpy.Type

Defines what type of object should be created.

Returns

result : single google.protobuf.message

Returns a newly created object.

Anchor
integralpy.Grid.export_to_db integralpy.Grid.export_to_db

export_to_db(db_name, ip, username, password, port)

Exports the current grid to database.

Anchor
integralpy.Grid.get integralpy.Grid.get

get(type=[], attr=[], ids=[])

Fetches a single object or a list of objects.

Parameters

type : single integralpy.Type or list of integralpy.Type

Defines what types of objects should be fetched.

attr: single intergralpy.Attribute or list of integralpy.Attribute

Defines what attributes of what object types should be fetched.

ids: single number or list of numbers

Defines what objects by id should be fetched.

Returns

result : single google.protobuf.message or list of google.protobuf.message

Returns a single or list of objects from grid.

Anchor
integralpy.Grid.get_base_load_flow_results integralpy.Grid.get_base_load_flow_results

get_base_load_flow_results()

Get two tables of results in CSV format.

Anchor
integralpy.Grid.get_branch_max_load_results integralpy.Grid.get_branch_max_load_results

get_branch_max_load_results()

Returns a dictionary with key the id of branch and value the maximum load of the branch.

Returns

result : dict

Returns a dictionary with key as id of branch and value as the maximum load of the branch

Anchor
integralpy.Grid.get_connected_loads_and_injections integralpy.Grid.get_connected_loads_and_injections

get_connected_loads_and_injections(id)

Anchor
integralpy.Grid.makroAPI integralpy.Grid.makroAPI

makroAPI()

Anchor
integralpy.Grid.remove integralpy.Grid.remove

remove(objects)

Removes multiple objects from the grid data.

Parameters

objects : list of google.protobuf.message or of numbers

Defines what objects should be removed from the grid by the object or id.

Anchor
integralpy.Grid.remove_attribute integralpy.Grid.remove_attribute

remove_attribute(type, attr=[], ids=[])

Removes attributes of exisiting objects.

Parameters

type : single integralpy.Type or list of integralpy.Type

Defines what types of objects should have attributes removed.

attr: single intergralpy.Attribute or list of integralpy.Attribute

Defines what attributes of what object types should be removed.

ids: single number or list of numbers

Defines what objects by id should have their attributes changed.

Anchor
integralpy.Grid.remove_grid integralpy.Grid.remove_grid

remove_grid()

Anchor
integralpy.Grid.update integralpy.Grid.update

update()

Updates the pointers and fields of internal grid model.

Anchor
integralpy.Grid.write integralpy.Grid.write

write(objects)

Writes single or multiple objects to the grid data.

Parameters

objects : single google.protobuf.message or list of google.protobuf.message

Defines what objects should be written to the grid. The not given attributes are not changed in the grid.

Anchor
integralpy.Session integralpy.Session

class integralpy.Session(url=None)

Bases: object

Anchor
integralpy.Session.close integralpy.Session.close

close()

Close gRPC connection gracefully.

Anchor
integralpy.Session.get_current_grid integralpy.Session.get_current_grid

get_current_grid()

Returns integralpy.Grid object for currently loaded grid.

Returns

result : integralpy.Grid

Returns a Grid object

Anchor
integralpy.Session.import_from_db integralpy.Session.import_from_db

import_from_db(dbname, host_ip, username, password, port)

Loads grid data from database and returns integralpy.Grid object.

Parameters

dbname : str

Database name

host_ip : str

Host name

username : str

User name

password : str

Password

port : int

Port number

Returns

result : integralpy.Grid

Returns a Grid object

Anchor
integralpy.Session.load_grid_file integralpy.Session.load_grid_file

load_grid_file(path)

Loads grid data from file and returns integralpy.Grid object.

Parameters

path : str

Relative or absolute path to locally stored .xml or .zip grid data.

Returns

result : integralpy.Grid

Returns a Grid object

Anchor
integralpy.Session.load_grid_file_cim integralpy.Session.load_grid_file_cim

load_grid_file_cim(paths)

Loads CIM grid data from ZIP file and returns integralpy.Grid object.

Parameters

path : list of str

List of absolute paths where of the ZIP files.

Returns

result : integralpy.Grid

Returns a Grid object

Anchor
integralpy.Session.merge_tso_dso_and_load_grid_files integralpy.Session.merge_tso_dso_and_load_grid_files

merge_tso_dso_and_load_grid_files(tso_files, dso_files, boundary_file)

Loads and merges grid from TSO and DSO grid ZIP files and returns integralpy.Grid object.

Parameters

tso_files : list of str

List of absolute paths where the ZIP files for TSO grid.

dso_files : list of str

List of absolute paths where the ZIP files for TSO grid.

boundary_file : str

Absolute path for boundary data.

Returns

result : integralpy.Grid

Returns a Grid object

Anchor
integralpy.connect integralpy.connect

integralpy.connect(host=None)

Initializes the connection to the host and returns a session object.

Parameters

host : str

The host (e.g. IP address and port)

Returns

result : integralpy.Session

Returns a Session object