CGMES2PGM-Suite

cgmes2pgm_suite provides additional tools for cgmes2pgm_converter to integrate PowerGridModel with the Common Grid Model Exchange Standard (CGMES). It focuses on performing the state estimation on CGMES datasets.

Features

• Start an Apache Jena Fuseki as docker container
• Upload Datasets to a SPARQL endpoint
• Human readable exports of PGM Datasets in TXT and Excel
• Create SV-Profile from PGM Results
• Debug state estimation by manipulating datasets (e.g., subnet splitting)
• Configure conversion and state estimation via a configuration file
• Simulate measurements:
  • when real measurements are not provided via an Operation Profile, but a State Variable (SV) Profile is available
  • generates an Operation Profile with distorted measurements based on the SV Profile

Installation

The package can be installed via pip:

pip install cgmes2pgm_suite

To start an Apache Jena Fuseki server via this package, Docker is required. See Docker installation guide.

Usage

This package can be run as a standalone application, performing the conversion and running PGM's state estimation. To do so, you need to install the package and then run the following command:

python -m cgmes2pgm_suite --config <path_to_config_file>

The provided configuration file contains the dataset configuration and the parameters for the conversion and state estimation. An example configuration file can be found in /example.

Quick Start

For a quick start, we recommend cloning this project and using the provided test cases.

If the project is cloned, setup the environment and install the package:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e ".[dev]"
pre-commit install

To run the Conformity Datasets, you need to download Test Configurations v3.0.3 from ENTSO-E CIM Conformity and Interoperability respecting their License. Place the rdf/xml files of each dataset in the respective subdirectory of tests/datasets.

Afterwards, you can run all datasets using:

pytest -m "integration"

Note: Running the tests creates a Fuseki Docker container on port 3030. The container is automatically removed after the tests are finished.

The results of the tests can be found in the tests/out directory.

If you want to add your own datasets, the following steps are required:

• Place the rdf/xml files in the tests/data/ directory
• Create a configuration file in the tests/configs/ directory, by copying an existing one
• Update the name, output directory and location of the rdf/xml files in the new configuration file

Datasets

The conversion, measurement simulation and state estimation has been tested with the CGMES conformity datasets.

The following datasets have been tested:

Dataset Version: CGMES Conformity Assessment Scheme Test Configurations v3.0.2

The used configuration files can be found in the /tests/configs directory.

License

This project is licensed under the Apache License 2.0.

Dependencies

This project includes third-party dependencies, which are licensed under their own respective licenses.

• cgmes2pgm_converter (Apache License 2.0)
• bidict (Mozilla Public License 2.0)
• numpy (BSD License)
• pandas (BSD License)
• power-grid-model (Mozilla Public License 2.0)
• power-grid-model-io (Mozilla Public License 2.0)
• SPARQLWrapper (W3C License)
• XlsxWriter (BSD License)
• PyYAML (MIT License)
• StrEnum (MIT License)
• docker (Apache License 2.0)

This project includes code from jena-fuseki-docker in the src/cgmes2pgm_suite/resources/docker directory, which is redistributed under the original Apache License 2.0. See the root‑level NOTICE file for full attribution.

Commercial Support and Services

For organizations requiring commercial support, professional maintenance, integration services, or custom extensions for this project, these services are available from SOPTIM AG.

Please feel free to contact us via powergridmodel@soptim.de.

Contributing

We welcome contributions to improve this project. Please see our Contributing Guide for details on how to submit pull requests, report issues, and suggest improvements.

Code of Conduct

This project adheres to a code of conduct adapted from the Apache Foundation's Code of Conduct. We expect all contributors and users to follow these guidelines to ensure a welcoming and inclusive community.