Skip to main content

Power Grid Model extension which provides a grid data structure for simulation and analysis

Project description

PyPI version License: MIT Downloads Downloads

CI Build docs

Quality Gate Status Coverage Maintainability Rating Reliability Rating Security Rating Vulnerabilities

Nightly build

DOI

Power Grid Model logo

Power Grid Model Data Science (DS)

The Power Grid Model DS project extends the capabilities of the power-grid-model calculation core with a modelling and simulation interface. This is aimed at building data science software applications related to or using the power-grid-model project. It defines a Grid dataclass which manages the consistency of the complete network.

Some highlighted features:

  • Using a model definition that corresponds to the power-grid-model, through which it is easy to do efficient grid calculations.
  • The extended numpy model provides features which make development more pleasant and easy.
  • Using the graph representation of the network, graph algorithms in rustworkx can be used to analyze the network.
  • An interface to model network mutations which is useful in simulation use-cases.
  • Visualization for easy exploration and debugging.
Grid Visualisation

See the power-grid-model-ds documentation for more information.

Installation

Pip

pip install power-grid-model-ds

uv

uv add power-grid-model-ds

License

This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.

Licenses third-party libraries

This project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.

Contributing

Please read CODE_OF_CONDUCT and CONTRIBUTING for details on the process for submitting pull requests to us.

Citations

If you are using Power Grid Model DS in your research work, please consider citing our library using the following references.

DOI

@software{Schouten_PowerGridModel_power-grid-model-ds,
  author = {Schouten, Jaap and Baaijen, Thijs and Koppen, Vincent and van der Voort, Sven and {Contributors to the LF Energy project Power Grid Model}},
  doi = {10.5281/zenodo.14825565},
  license = {MPL-2.0},
  title = {{PowerGridModel/power-grid-model-ds}},
  url = {https://github.com/PowerGridModel/power-grid-model-ds}
}
@software{Xiang_PowerGridModel_power-grid-model,
  author = {Xiang, Yu and Salemink, Peter and van Westering, Werner and Bharambe, Nitish and Govers, Martinus G.H. and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry Jinfeng and Figueroa Manrique, Santiago and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},
  doi = {10.5281/zenodo.8054429},
  license = {MPL-2.0},
  title = {{PowerGridModel/power-grid-model}},
  url = {https://github.com/PowerGridModel/power-grid-model}
}
@inproceedings{Xiang2023,
  author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner},
  booktitle={27th International Conference on Electricity Distribution (CIRED 2023)},
  title={Power grid model: a high-performance distribution grid calculation library},
  year={2023},
  volume={2023},
  number={},
  pages={1089-1093},
  keywords={},
  doi={10.1049/icp.2023.0633}
}

Contact

Please read SUPPORT for how to connect and get into contact with the Power Grid Model project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

power_grid_model_ds-1.6.1.tar.gz (60.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

power_grid_model_ds-1.6.1-py3-none-any.whl (89.7 kB view details)

Uploaded Python 3

File details

Details for the file power_grid_model_ds-1.6.1.tar.gz.

File metadata

  • Download URL: power_grid_model_ds-1.6.1.tar.gz
  • Upload date:
  • Size: 60.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for power_grid_model_ds-1.6.1.tar.gz
Algorithm Hash digest
SHA256 6b5e57ad85b4e550959fee0648c7bb4f7ee18c393321971e4cf88e800893df01
MD5 b7eb2e90bf69cea8ea1b197623e0e605
BLAKE2b-256 c3a963dc2423de0a2b32f4ab31d538ed2bbd21cbfc0bb01f2b57193550d31ade

See more details on using hashes here.

Provenance

The following attestation bundles were made for power_grid_model_ds-1.6.1.tar.gz:

Publisher: ci.yml on PowerGridModel/power-grid-model-ds

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file power_grid_model_ds-1.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for power_grid_model_ds-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c5f4384909f9706daddb1e6dde9177f3db64975e5d9926e73bc8b7ac5239e0f8
MD5 17b9816be023dbc4d16888833591cbf1
BLAKE2b-256 410ba18df5a80bc4be145de473313649b5e3a072dd021b2c844898d6b263e3fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for power_grid_model_ds-1.6.1-py3-none-any.whl:

Publisher: ci.yml on PowerGridModel/power-grid-model-ds

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page