Grid Creation¶

This module provides functions for creating and manipulating power system grids.

functions are found in pyflow_acdc.Grid_creator

Core Grid Class¶

Creating a Grid¶

import pyflow_acdc as pyf
grid = pyf.Grid()

Create Grid From Data¶

A more detailed description of the function can be found in the CSV files for importing data page.

Create_grid_from_data(S_base, AC_node_data=None, AC_line_data=None, DC_node_data=None, DC_line_data=None, Converter_data=None, data_in='Real')¶

Creates a new grid from pandas DataFrames containing component data.

Parameter	Type	Description
`S_base`	float	Base power in MVA
`AC_node_data`	DataFrame	AC node pandas, geopandas or csv string
`AC_line_data`	DataFrame	AC line pandas, geopandas or csv string
`DC_node_data`	DataFrame	DC node pandas, geopandas or csv string
`DC_line_data`	DataFrame	DC line pandas, geopandas or csv string
`Converter_data`	DataFrame	Converter pandas, geopandas or csv string
`data_in`	str	Input data format (‘pu’ or ‘Ohm’ if not assumed in Real values)
Returns	grid, res	Grid and Results objects

Example

grid, results = pyf.Create_grid_from_data(100, ac_nodes_df, ac_lines_df)

Create Grid From Matpower¶

Create_grid_from_mat(matfile)¶

Creates a grid from a MATPOWER case file.

Load your (.m) matpower case in matlab and save the variable as a .mat file.

Parameters:: matfile (str) – Path to .mat file
Returns:: Grid and Results objects
Return type:: list[Grid, Results]

Example

grid, results = pyf.Create_grid_from_mat("case9.mat")

Extend Grid From Data¶

Extend_grid_from_data(grid, AC_node_data=None, AC_line_data=None, DC_node_data=None, DC_line_data=None, Converter_data=None, data_in='Real')¶

Extends an existing grid with additional components.

Parameter	Type	Description
`grid`	Grid	Existing grid to extend
`AC_node_data`	DataFrame	AC node pandas, geopandas or csv string
`AC_line_data`	DataFrame	AC line pandas, geopandas or csv string
`DC_node_data`	DataFrame	DC node pandas, geopandas or csv string
`DC_line_data`	DataFrame	DC line pandas, geopandas or csv string
`Converter_data`	DataFrame	Converter pandas, geopandas or csv string
`data_in`	str	Input data format (‘Real’ or ‘pu’)
Returns	Grid	Extended grid object

Example

pyf.Extend_grid_from_data(grid, new_ac_nodes_df)

Reset All Classes¶

initialize_pyflowacdc()¶

Resets all component class counters. This function is neeed if you have installed pyflow_acdc directly from pip. Create_grid_from_data and Create_grid_from_mat automatically call this function so you dont need to.

Example

pyf.initialize_pyflowacdc()

Change Base Power¶

under development

change_S_base(grid, Sbase_new)¶

Changes the power base of a grid.

Parameter	Type	Description
`grid`	Grid	Grid to modify
`Sbase_new`	float	New base power in MVA
Returns	Grid	Modified grid

Example

pyf.change_S_base(grid, 100)

Create Sub Grid¶

create_sub_grid(grid, Area=None, Area_name=None, polygon_coords=None)¶

Creates a sub-grid from a larger grid based on area or coordinates. At the moment only works unidirectionally, initial grid is useless after creation of sub-grid. Sub-grid is created as a new grid object. can be created from Area objects, area object names or polygon coordinates.

Parameter	Type	Description
`grid`	Grid	Original grid
`Area`	list of Area objects	Area object defining sub-grid
`Area_name`	list of str	Name of area for sub-grid
`polygon_coords`	polygon coordinates	Coordinates defining sub-grid boundary
Returns	list[Grid, Results]	Sub-grid and Results objects

Example

subgrid, results = create_sub_grid(grid, Area_name="Zone1")