Dataset Terminology
Some terms regarding the data structures are explained here, including the definition of dataset, component, and attribute. For detailed data types used throughout power-grid-model
, please refer to Python API Reference.
Data structures
Dataset: Either a single or a batch dataset.
SingleDataset: A data type storing input data (i.e. all elements of all components) for a single scenario.
BatchDataset: A data type storing update and or output data for one or more scenarios. A batch dataset can contain sparse or dense data, depending on the component.
DataArray A data array can be a single or a batch array. It is a numpy structured array.
SingleArray A dictionary where the keys are the component types and the values are one-dimensional structured numpy arrays.
BatchArray: An array of dictionaries where the keys are the component types and the values are two-dimensional structured numpy arrays.
DenseBatchArray: A two-dimensional structured numpy array containing a list of components of the same type for each scenario.
SparseBatchArray: A dictionary with a one-dimensional numpy int64 array and a one-dimensional structured numpy arrays.
Type of Dataset
The types of Dataset
include the following: input
, update
, sym_output
, asym_output
, and sc_output
:
Exemplery datasets attributes are given in a dataset containing a line
component.
input: Contains attributes relevant to configuration of grid.
Example:
id
,from_node
,from_status
update: Contains attributes relevant to multiple scenarios.
Example:
from_status
,to_status
sym_output: Contains attributes relevant to symmetrical steady state output of power flow or state estimation calculation.
Example:
p_from
,p_to
asym_output: Contains attributes relevant to asymmetrical steady state output of power flow or state estimation calculation. Attributes are similar to
sym_output
except some values of the asymmetrical dataset will contain detailed data for all 3 phases individually.Example:
p_from
,p_to
sc_output: Contains attributes relevant to symmetrical short circuit calculation output. Like for the
asym_output
, detailed data for all 3 phases will be provided where relevant.Example:
i_from
,i_from_angle
Attributes of Components
Attribute |
Description |
---|---|
name |
Name of the attribute. It is exactly the same as the attribute name in |
data type |
Data type of the attribute. It is either a type from the table in Native Data Interface, or an enumeration as defined above. There are two special data types that are independent from one another, namely, |
|
|
|
|
unit |
Unit of the attribute, if applicable. As a general rule, only standard SI units without any prefix are used. |
description |
Description of the attribute. |
required |
Whether the attribute is required. If not, then it is optional. Note if you choose not to specify an optional attribute, it should have the null value as defined in Basic Data Types. |
update |
Whether the attribute can be mutated by the update call |
valid values |
Whether applicable or not; an indication of value validity for the input data. |