Power Grid Model

A library for steady-state distribution power system analysis distributed for Python and C.
https://github.com/PowerGridModel/power-grid-model

Category: Energy Systems
Sub Category: Grid Analysis and Planning

Keywords

cpp eigen3 numpy powerflow powersystem python shortcircuit stateestimation

Keywords from Contributors

transforms archiving measur generic compose optimize animals conversion observation projection

Last synced: about 4 hours ago
JSON representation

Repository metadata

Python/C++ library for distribution power system analysis

README.md

PyPI version
Anaconda-Server Badge
License: MPL2.0
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

power-grid-model is a library for steady-state distribution power system analysis distributed for Python and C.
The core of the library is written in C++.
Currently, it supports the following calculations:

  • Power Flow
  • State Estimation
  • Short Circuit

See the power-grid-model documentation for more information.
For various conversions to the power-grid-model, refer to the power-grid-model-io repository.
For an extended python interface to the the power-grid-model, refer to the power-grid-model-ds repository.

Want to be updated on the latest news and releases? Subscribe to the Power Grid Model mailing list by sending an (empty) email to: [email protected]

Installation

Install from PyPI

You can directly install the package from PyPI.

pip install power-grid-model

Install from Conda

If you are using conda, you can directly install the package from conda-forge channel.

conda install -c conda-forge power-grid-model

Build and install from Source

To install the library from source, refer to the Build Guide.

Examples

Please refer to Examples for more detailed examples for power flow and state estimation.
Notebooks for validating the input data and exporting input/output data are also included.

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, CONTRIBUTING, PROJECT GOVERNANCE and RELEASE for details on the process
for submitting pull requests to us.

Visit Contribute for a list of good first issues in this repo.

Citations

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

DOI

@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.

Citation (CITATION.cff)

# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
#
# SPDX-License-Identifier: MPL-2.0

cff-version: 1.2.0
message: "If you are using Power Grid Model in your research work, please consider citing our library as below."

title: "PowerGridModel/power-grid-model"
url: "https://github.com/PowerGridModel/power-grid-model"
doi: "10.5281/zenodo.8054429"
license: "MPL-2.0"
authors:
  - family-names: "Xiang"
    given-names: "Yu"
    email: "[email protected]"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0001-5889-0067"
  - family-names: "Salemink"
    given-names: "Peter"
    email: "[email protected]"
    affiliation: "Alliander"
  - family-names: "Westering"
    name-particle: "van"
    given-names: "Werner"
    email: [email protected]
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0002-4058-2581"
  - family-names: "Bharambe"
    given-names: "Nitish"
    email: "[email protected]"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0009-0007-9694-6077"
  - family-names: "Govers"
    given-names: "Martinus G.H."
    email: "[email protected]"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0009-0008-6890-8353"
  - family-names: "Bogaard"
    name-particle: "van den"
    given-names: "Jonas"
    email: "[email protected]"
    affiliation: "Alliander"
  - family-names: "Stoeller"
    given-names: "Bram"
  - family-names: "Wang"
    given-names: "Zhen"
    email: "[email protected]"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0003-4317-6455"
  - family-names: "Guo"
    given-names: "Jerry Jinfeng"
    email: "[email protected]"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0002-8065-4084"
  - family-names: "Figueroa Manrique"
    given-names: "Santiago"
    email: "[email protected]"
    affiliation: "Alliander"
  - family-names: "Jagutis"
    given-names: "Laurynas"
    email: "[email protected]"
    affiliation: "Alliander"
  - family-names: "Wang"
    given-names: "Chenguang"
    email: "[email protected]"
    affiliation: "Alliander"
  - family-names: "Raalte"
    name-particle: "van"
    given-names: "Marc"
    email: "[email protected]"
    affiliation: "Alliander"
  - name: "Contributors to the LF Energy project Power Grid Model"
contact:
  - name: "LF Energy project Power Grid Model"
    email: "[email protected]"

references:
  - title: "Power grid model: A high-performance distribution grid calculation library"
    doi: "10.1049/icp.2023.0633"
    authors:
      - family-names: "Xiang"
        given-names: "Yu"
        email: [email protected]
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0001-5889-0067"
      - family-names: "Salemink"
        given-names: "Peter"
        email: [email protected]
        affiliation: "Alliander"
      - family-names: "Stoeller"
        given-names: "Bram"
      - family-names: "Bharambe"
        given-names: "Nitish"
        email: [email protected]
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0007-9694-6077"
      - family-names: "Westering"
        name-particle: "van"
        given-names: "Werner"
        email: [email protected]
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0002-4058-2581"
    conference:
      name: "CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution"
    type: conference-paper
    year: 2023
    volume: 2023
    pages: "1-5"

  - title: "PowerGridModel/power-grid-model-ds"
    repository-code: "https://github.com/PowerGridModel/power-grid-model-ds"
    doi: "10.5281/zenodo.14825565"
    license: "MPL-2.0"
    type: software-code
    authors:
      - family-names: "Schouten"
        given-names: "Jaap"
        email: [email protected]
        affiliation: "Alliander"
      - family-names: "Baaijen"
        given-names: "Thijs"
        email: [email protected]
        affiliation: "Alliander"
      - family-names: "Koppen"
        given-names: "Vincent"
        email: [email protected]
      - family-names: "Voort"
        name-particle: "van der"
        given-names: "Sven"
        email: [email protected]
      - name: "Contributors to the LF Energy project Power Grid Model"

  - title: "PowerGridModel/power-grid-model-io"
    repository-code: "https://github.com/PowerGridModel/power-grid-model-io"
    doi: "10.5281/zenodo.8059257"
    license: "MPL-2.0"
    type: software-code
    authors:
      - family-names: "Xiang"
        given-names: "Yu"
        email: "[email protected]"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0001-5889-0067"
      - family-names: "Salemink"
        given-names: "Peter"
        email: "[email protected]"
        affiliation: "Alliander"
      - family-names: "Bharambe"
        given-names: "Nitish"
        email: "[email protected]"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0007-9694-6077"
      - family-names: "Govers"
        given-names: "Martinus G.H."
        email: "[email protected]"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0008-6890-8353"
      - family-names: "Bogaard"
        name-particle: "van den"
        given-names: "Jonas"
        email: "[email protected]"
        affiliation: "Alliander"
      - family-names: "Stoeller"
        given-names: "Bram"
      - family-names: "Wang"
        given-names: "Zhen"
        email: "[email protected]"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0003-4317-6455"
      - family-names: "Guo"
        given-names: "Jerry Jinfeng"
        email: "[email protected]"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0002-8065-4084"
      - family-names: "Figueroa Manrique"
        given-names: "Santiago"
        email: "[email protected]"
        affiliation: "Alliander"
      - family-names: "Jagutis"
        given-names: "Laurynas"
        email: "[email protected]"
        affiliation: "Alliander"
      - family-names: "Wang"
        given-names: "Chenguang"
        email: "[email protected]"
        affiliation: "Alliander"
      - name: "Contributors to the LF Energy project Power Grid Model"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 9 days ago

Total Commits: 6,282
Total Committers: 25
Avg Commits per committer: 251.28
Development Distribution Score (DDS): 0.696

Commits in past year: 2,326
Committers in past year: 15
Avg Commits per committer in past year: 155.067
Development Distribution Score (DDS) in past year: 0.663

Name Email Commits
Martijn Govers M****s@A****m 1911
Tony Xiang t****g@a****m 1538
Nitish Bharambe n****e@a****m 836
Jerry Guo J****o@a****m 483
Peter Salemink p****k@a****m 477
Santiago Figueroa s****e@a****m 408
Laurynas Jagutis l****s@a****m 247
Bram Stoeller b****r@a****m 159
Zhen Wang z****g@a****m 71
dependabot[bot] 4****] 62
Udo Schmitz u****z@s****e 17
ChenguangWang-Sam s****g@g****m 17
Emanuele Brentegani e****0@g****m 13
leovsch l****6@g****m 9
Sattama Datta s****a@a****m 8
Jonas van den Bogaard 3****o 8
ekiwaka k****3@g****m 4
Thijs Baaijen T****s 4
Frank Kreuwel f****l@g****m 3
LeiWuInfo l****u@l****m 2
Paul Schulz p****l@m****g 1
jaapschoutenalliander j****n@a****m 1
benjamin.wang b****d@g****m 1
Tony Xiang t****g@T****n 1
sudo-ac 1****c 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 196
Total pull requests: 629
Average time to close issues: 4 months
Average time to close pull requests: 6 days
Total issue authors: 23
Total pull request authors: 20
Average comments per issue: 1.94
Average comments per pull request: 2.47
Merged pull request: 564
Bot issues: 0
Bot pull requests: 44

Past year issues: 94
Past year pull requests: 335
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 6 days
Past year issue authors: 14
Past year pull request authors: 15
Past year average comments per issue: 1.82
Past year average comments per pull request: 2.4
Past year merged pull request: 303
Past year bot issues: 0
Past year bot pull requests: 20

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/PowerGridModel/power-grid-model

Top Issue Authors

  • mgovers (77)
  • TonyXiang8787 (37)
  • petersalemink95 (20)
  • Jerry-Jinfeng-Guo (15)
  • nitbharambe (13)
  • figueroa1395 (7)
  • SanPen (3)
  • Thijss (3)
  • sudo-ac (3)
  • Jonasvdbo (2)
  • leiwu84 (2)
  • bartgips (2)
  • wfjvdham (2)
  • jaccoheres (1)
  • Flinverdaasdonk (1)

Top Pull Request Authors

  • mgovers (243)
  • nitbharambe (70)
  • Jerry-Jinfeng-Guo (67)
  • TonyXiang8787 (63)
  • dependabot[bot] (44)
  • figueroa1395 (43)
  • Laurynas-Jagutis (36)
  • petersalemink95 (21)
  • zhen0427 (20)
  • leovsch (4)
  • scud-soptim (3)
  • emabre (3)
  • Welthulk (2)
  • sudo-ac (2)
  • ekiwaka (2)

Top Issue Labels

  • feature (129)
  • good first issue (38)
  • improvement (30)
  • bug (26)
  • documentation (8)
  • wontfix (6)
  • duplicate (1)

Top Pull Request Labels

  • improvement (146)
  • feature (117)
  • bug (72)
  • dependencies (70)
  • documentation (56)
  • do-not-merge (10)
  • github_actions (8)
  • wontfix (1)

Dependencies

pyproject.toml pypi
  • numpy >=1.21.0
.github/workflows/check-code-quality.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • docker/setup-qemu-action v2 composite
  • pypa/cibuildwheel v2.11.4 composite
  • softprops/action-gh-release v1 composite
.github/workflows/reuse-compliance.yml actions
  • actions/checkout v3 composite
  • fsfe/reuse-action v1 composite
.github/workflows/sonar.yml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
  • actions/setup-python v4 composite
.github/workflows/citations.yml actions
  • actions/checkout v4 composite
  • dieghernan/cff-validator v2.3 composite
.github/workflows/clang-tidy.yml actions
  • actions/checkout v4 composite
code_generation/requirements.txt pypi
  • dataclasses_json *
  • jinja2 *
setup.py pypi

Score: 8.724207360800563