https://github.com/ieeh-tu-dresden/power-system-data-model

A hierarchical data model for the description of electrical power systems.
https://github.com/ieeh-tu-dresden/power-system-data-model

datamodel powersystem python

Last synced: 5 months ago
JSON representation

A hierarchical data model for the description of electrical power systems.

• Host: GitHub
• URL: https://github.com/ieeh-tu-dresden/power-system-data-model
• Owner: ieeh-tu-dresden
• License: bsd-3-clause
• Created: 2023-02-24T09:35:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-12-19T11:58:18.000Z (6 months ago)
• Last Synced: 2025-12-22T04:32:14.446Z (6 months ago)
• Topics: datamodel, powersystem, python
• Language: Python
• Homepage:
• Size: 14.4 MB
• Stars: 7
• Watchers: 0
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Authors: AUTHORS.md
  • Zenodo: .zenodo.json

Awesome Lists containing this project

README

          

# PowerSystem Data Model

[![image](https://img.shields.io/pypi/v/ieeh-power-system-data-model.svg)](https://pypi.python.org/pypi/ieeh-power-system-data-model)

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://docs.pydantic.dev/latest/contributing/#badges)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8087079.svg)](https://doi.org/10.5281/zenodo.8087079)



  



A data model for the description of electrical power systems.

- [Field of Application](#field-of-application)

  - [Grid Topology](#grid-topology)

  - [Topology Case](#topology-case)

  - [Steadystate Case](#steadystate-case)

- [General Remarks](#general-remarks)

- [Installation](#installation)

- [Development](#development)

- [Attribution](#attribution)

## Field of Application

This data model is intended to describe electrical power systems.

It provides a hierarchical structure/schema to describe unique entity relations as well as parameter sets.

Read also this comprehensive [blog post](https://medium.com/@Sebastian-DD/export-a-network-from-powerfactory-to-the-power-system-data-model-db46103bdabe) about the PSDM.

The data model is structured as the following schema:

### Grid Topology

This is the base topology containing all elements of the exported grid:

- Branches (symmetrical: overhead lines, cables, fuses from type "branch")

- Nodes

- Transformers (symmetrical: 2- or 3-winding)

- External grids

- Loads (consumer, producer, grid assets)

![topology relationship diagram](./docs/entity_rel__topology.png)

In addition to the explicitly defined element attributes, it is possible to save user-specific additional information as optional AttributeData ([Export example of powerfactory-tools](https://github.com/ieeh-tu-dresden/powerfactory-tools/blob/main/examples/powerfactory_export.ipynb)).

### Topology Case

This holds information about disabled elements to represent a specific operational case based on the base topology.

  ![topology case relationship diagram](./docs/entity_rel__topology_case.png)

### Steadystate Case

This holds information for a specific operational case such as:

- power draw/infeed of load

- tap position of transformer

- operating point of external grid

  ![steadystate case relationship diagram](./docs/entity_rel__steady_state_case.png)

## General Remarks

Please find below some important general remarks and assumptions to consider for consistent usage across different applications:

- The passive sign convention should be used for all types of loads (consumer as well as producer).

- Numeric values should be set using the SI unit convention.

- Topology

  - Only **symmetrical** grid assets, e.g. transformer or line, are supported.

  - The `Rated Power` should always be defined positive (absolute value).

- The interaction between load models and controllers are depicted in the following schematic:

  ![active/reactive power schematics](./docs/static/power_schematics.png)

## Installation

Just install via pip:

```bash

pip install ieeh-power-system-data-model

```

## Development

[Install the Python package and project manager uv](https://github.com/astral-sh/uv)

Clone `power-system-data-model`

```bash

git@github.com:ieeh-tu-dresden/power-system-data-model.git

```

```bash

cd power-system-data-model

```

Install `power-system-data-model` as a production tool

```bash

uv sync --no-dev

```

Install `power-system-data-model` in development mode

```bash

uv sync

```

For development in [Visual Studio Code](https://github.com/microsoft/vscode), all configurations are already provided:

- [ruff](https://github.com/astral-sh/ruff)

- [mypy](https://github.com/python/mypy)

## Attribution

Please provide a link to this repository:

Please cite as:

Institute of Electrical Power Systems and High Voltage Engineering - TU Dresden, _Power System Data Model - A data model for the description of electrical power systems_, Zenodo, 2023. .

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8087079.svg)](https://doi.org/10.5281/zenodo.8087079)

Alternatively, when using the PSDM together with the [powerfactory-tools](https://github.com/ieeh-tu-dresden/powerfactory-tools), please cite also:

S. Krahmer, S. J. Rasti, L. Fiedler and M. Schmidt, „PowerFactory-Tools: A Python Package to Facilitate the Control of DIgSILENT PowerFactory“. Journal of Open Source Software (JOSS), 10(116), 9281, 2025. doi: 10.21105/joss.09281.

[![DOI](https://joss.theoj.org/papers/10.21105/joss.09281/status.svg)](https://doi.org/10.21105/joss.09281)