Construct an array filled with zeros. If 'empty_id' is True, the 'id' column will be filled with EMPTY_ID values.

Append an array to the grid. Both 'grid arrays' and 'grid.graphs' will be updated. Args: array (FancyArray): The array to append.

Create an empty grid Args: graph_model (type[BaseGraphModel], optional): The graph model to use. Defaults to RustworkxGraphModel.

Add a branch to the grid Args: branch (BranchArray): The branch to add

Add a new node to the grid Args: node (NodeArray): The node to add

Check if a branch exists between two nodes.

Generalized performance test runner.

Returns all arrays in the container.

Convert external node id to internal node id (internal) Raises: MissingNodeError: if the external node id does not exist in the g

Initialize the PowerGridModel and calculate power flow over input data. If input data is not available, self.create_input_from_grid() will be

Build a grid from a list of strings See the documentation for the expected format of the txt_lines Args: *args (str): Th

Remove a node from the grid Args: node (NodeArray): The node to remove

Create input for the PowerGridModel

Cache Grid to a folder Args: cache_dir (Path): The directory to save the cache to. cache_name (str): The name of the

Remove a branch from the grid Args: branch (BranchArray): The branch to remove

Find all nodes connected to the node_id Args: node_id: node id to start the search from inclusive: whether to include

Find a matching LineArray, LinkArray or TransformerArray for the given branch_ids Raises: ValueError: - If no bra

Returns True for lists, tuples, sets, arrays Return False for strings, dicts

Calculate the shortest path between two nodes Example: given this graph: [1] - [2] - [3] - [4] >>> graph.get_shortes

Run the generator to create a random radial grid. if a seed is provided, this will be used to set rng.

Build a basic grid

Returns the empty value for the given dtype.

Build from arrays

Read from cache and build .graphs from arrays Args: cache_path (Path): The path to the cache load_graphs (bool, optio

Convert internal id (internal) to external node id

Generate nodes in a grid with two possible load scenarios

Sets feeder and substation id properties in the grids arrays

Convert a list of internal nodes to external nodes

Find the Field that holds an array of type array_type. Args: array_type(type[FancyArray]): FancyArray subclass. Raises:

Check if a node exists.

Context manager that temporarily removes nodes and their branches from the graph. Example: >>> with graph.tmp_remove_nodes([1, 2,

Convert a list of external nodes to internal nodes

Decide on a number of routes based on expected route-size

Find the first connected node to the node_id from the candidate_node_ids Note: If multiple candidate nodes are connected to the n

Returns all branches within a path of nodes Args: nodes_in_path (list[int]): The nodes in the path Returns:

Returns all separate components when the substation_nodes are removed of the graph as lists

Returns a mask that matches the input parameters.

Returns the path to the pickle file. If ony a .gz-file is available, the .gz-file is unpacked.

Check if a column is filled with 'empty' values.

Make a branch inactive. This is done by setting from or to status to 0. Args: branch (BranchArray): The branch to make inactive

Parse the branch array.

Reverse the direction of the branches.

Set a column to its 'empty' value.

Add a branch to all graphs

Add a node to all graphs

Return a copy of this array including its data

Create Grid object from PowerGridModel input. Note that for some arrays, not all fields are available in the PowerGridModel input.

Return all branches that have the node as an endpoint.

Parse the nodes.

Generate routes, lines and normally open points (NOPs)

Attempts to find a record across all id-arrays within the container. This method is only intended for debugging purposes since it is very ine

From a line array and total set of nodes determine which are not yet connected

Add a branch array to the grid

Stringify the record (required by Dash).

Add a branch to all graphs

Add a branch to all graphs

Add all branches in the branch array to the graph.

Add a node to the graph.

Append the given asset_array to the corresponding field of ArrayContainer and generate ids. Args: array(FancyArray): the asset_ar

Return an array with the records that match the input parameters. Note: output could be an empty array.

Add a new line between an active and inactive line

Create the inactive lines between different routes (Normally Open Points)

Create a number of lines from the substation to unconnected nodes

Remove a branch3 from the grid Args: branch (Branch3Array): The branch3 to remove

Delete all branches in branch_array from the graph.

Remove a node from the graph. Args: ext_node_id(int): id of the node to remove raise_on_fail(bool): whether to raise

Return branches that have n_parallel connections. Args: branches: BranchArray. n_parallel: the number of connections

Find all fundamental cycles in the graph. Returns: list[list[int]]: list of cycles, each cycle is a list of (external) node ids

Retrieves all paths between two (external) nodes. Returns a list of paths, each path containing a list of external nodes.

Get the app layout.

Get the Cytoscape HTML element

Get the downstream nodes from a node. Assuming each node has a single feeding substation and the grid is radial Example:

Get the attribute from the object and all its parents

Find the nearest substation node. Args: node_id(int): The id of the node to find the nearest substation node for. Return

unzip a gzip (.gz) file

Load a grid from text

Make a branch active Args: branch (BranchArray): The branch to make active