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

loadflow power short-circuit state-estimation system

Last synced: about 13 hours ago
JSON representation

Repository metadata

Python/C++ library for distribution power system analysis

README.md

Power Grid Model logo

PyPI version
PyPI Downloads
PyPI Downloads per month

Anaconda-Server Badge
Anaconda-Server Platforms
Anaconda-Server Downloads

License: MPL2.0
OpenSSF Best Practices
DOI

CI Build
docs
Nightly build

Quality Gate Status
Coverage
Maintainability Rating
Reliability Rating
Security Rating
Vulnerabilities

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: powergridmodel+subscribe@lists.lfenergy.org

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 <powergridmodel@lfenergy.org>
#
# 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: "Tony.Xiang@Alliander.com"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0001-5889-0067"
  - family-names: "Salemink"
    given-names: "Peter"
    email: "Peter.Salemink@Alliander.com"
    affiliation: "Alliander"
  - family-names: "Westering"
    name-particle: "van"
    given-names: "Werner"
    email: Werner.van.Westering@Alliander.com
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0002-4058-2581"
  - family-names: "Bharambe"
    given-names: "Nitish"
    email: "Nitish.Bharambe@Alliander.com"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0009-0007-9694-6077"
  - family-names: "Govers"
    given-names: "Martinus G.H."
    email: "Martijn.Govers@Alliander.com"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0009-0008-6890-8353"
  - family-names: "Bogaard"
    name-particle: "van den"
    given-names: "Jonas"
    email: "Jonas.van.den.Bogaard@Alliander.com"
    affiliation: "Alliander"
  - family-names: "Stoeller"
    given-names: "Bram"
  - family-names: "Wang"
    given-names: "Zhen"
    email: "Zhen.Wang@Alliander.com"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0003-4317-6455"
  - family-names: "Guo"
    given-names: "Jerry Jinfeng"
    email: "Jerry.Jinfeng.Guo@hotmail.com"
    affiliation: "Alliander"
    orcid: "https://orcid.org/0000-0002-8065-4084"
  - family-names: "Figueroa Manrique"
    given-names: "Santiago"
    email: "Santiago.Figueroa.Manrique@Alliander.com"
    affiliation: "Alliander"
  - family-names: "Jagutis"
    given-names: "Laurynas"
    email: "Laurynas.Jagutis@Alliander.com"
    affiliation: "Alliander"
  - family-names: "Wang"
    given-names: "Chenguang"
    email: "Chenguang.Wang@Alliander.com"
    affiliation: "Alliander"
  - family-names: "Raalte"
    name-particle: "van"
    given-names: "Marc"
    email: "Marc.van.Raalte@Alliander.com"
    affiliation: "Alliander"
  - name: "Contributors to the LF Energy project Power Grid Model"
contact:
  - name: "LF Energy project Power Grid Model"
    email: "powergridmodel@lists.lfenergy.org"

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: Tony.Xiang@Alliander.com
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0001-5889-0067"
      - family-names: "Salemink"
        given-names: "Peter"
        email: Peter.Salemink@Alliander.com
        affiliation: "Alliander"
      - family-names: "Stoeller"
        given-names: "Bram"
      - family-names: "Bharambe"
        given-names: "Nitish"
        email: Nitish.Bharambe@Alliander.com
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0007-9694-6077"
      - family-names: "Westering"
        name-particle: "van"
        given-names: "Werner"
        email: Werner.van.Westering@Alliander.com
        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: Jaap.Schouten@Alliander.com
        affiliation: "Alliander"
      - family-names: "Baaijen"
        given-names: "Thijs"
        email: Thijs.Baaijen@Alliander.com
        affiliation: "Alliander"
      - family-names: "Koppen"
        given-names: "Vincent"
        email: Vincent.Koppen@Alliander.com
      - family-names: "Voort"
        name-particle: "van der"
        given-names: "Sven"
        email: Sven.van.der.Voort@Alliander.com
      - 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: "Tony.Xiang@Alliander.com"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0001-5889-0067"
      - family-names: "Salemink"
        given-names: "Peter"
        email: "Peter.Salemink@Alliander.com"
        affiliation: "Alliander"
      - family-names: "Bharambe"
        given-names: "Nitish"
        email: "Nitish.Bharambe@Alliander.com"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0007-9694-6077"
      - family-names: "Govers"
        given-names: "Martinus G.H."
        email: "Martijn.Govers@Alliander.com"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0009-0008-6890-8353"
      - family-names: "Bogaard"
        name-particle: "van den"
        given-names: "Jonas"
        email: "Jonas.van.den.Bogaard@Alliander.com"
        affiliation: "Alliander"
      - family-names: "Stoeller"
        given-names: "Bram"
      - family-names: "Wang"
        given-names: "Zhen"
        email: "Zhen.Wang@Alliander.com"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0003-4317-6455"
      - family-names: "Guo"
        given-names: "Jerry Jinfeng"
        email: "Jerry.Jinfeng.Guo@hotmail.com"
        affiliation: "Alliander"
        orcid: "https://orcid.org/0000-0002-8065-4084"
      - family-names: "Figueroa Manrique"
        given-names: "Santiago"
        email: "Santiago.Figueroa.Manrique@Alliander.com"
        affiliation: "Alliander"
      - family-names: "Jagutis"
        given-names: "Laurynas"
        email: "Laurynas.Jagutis@Alliander.com"
        affiliation: "Alliander"
      - family-names: "Wang"
        given-names: "Chenguang"
        email: "Chenguang.Wang@Alliander.com"
        affiliation: "Alliander"
      - name: "Contributors to the LF Energy project Power Grid Model"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 8,543
Total Committers: 40
Avg Commits per committer: 213.575
Development Distribution Score (DDS): 0.692

Commits in past year: 1,760
Committers in past year: 25
Avg Commits per committer in past year: 70.4
Development Distribution Score (DDS) in past year: 0.692

Name Email Commits
Martijn Govers M****s@A****m 2635
Tony Xiang t****g@a****m 1861
Nitish Bharambe n****e@a****m 1055
Jerry Guo J****o@a****m 740
Santiago Figueroa s****e@a****m 616
Peter Salemink p****k@a****m 485
Laurynas Jagutis l****s@a****m 410
Bram Stoeller b****r@a****m 159
dependabot[bot] 4****] 122
Zhen Wang z****g@a****m 97
furqan463 a****c@g****m 73
Eduard Fried e****d@s****e 48
jhe J****o@o****m 40
power-grid-model-ci-bot[bot] 2****] 36
Clemens Korner c****r@g****m 23
marc van raalte m****e@a****m 20
Udo Schmitz u****z@s****e 18
ChenguangWang-Sam s****g@g****m 17
Emanuele Brentegani e****0@g****m 13
Akshat Pandey a****1@g****m 11
Steffan Wullems 1****s 10
leovsch l****6@g****m 9
Sattama Datta s****a@a****m 8
Jonas van den Bogaard 3****o 8
Thijs Baaijen T****s 4
ekiwaka k****3@g****m 4
Frank Kreuwel f****l@g****m 3
Weiping Yan 1****g 3
ErnestBeckham e****8@g****m 2
Zain Asif z****1@g****m 2
and 10 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 221
Total pull requests: 1,224
Average time to close issues: 5 months
Average time to close pull requests: 6 days
Total issue authors: 31
Total pull request authors: 34
Average comments per issue: 1.97
Average comments per pull request: 2.19
Merged pull request: 995
Bot issues: 0
Bot pull requests: 129

Past year issues: 37
Past year pull requests: 228
Past year average time to close issues: 2 months
Past year average time to close pull requests: 6 days
Past year issue authors: 14
Past year pull request authors: 24
Past year average comments per issue: 2.84
Past year average comments per pull request: 1.92
Past year merged pull request: 152
Past year bot issues: 0
Past year bot pull requests: 67

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

Top Issue Authors

  • mgovers (77)
  • TonyXiang8787 (36)
  • nitbharambe (22)
  • petersalemink95 (22)
  • Jerry-Jinfeng-Guo (15)
  • figueroa1395 (14)
  • sudo-ac (4)
  • WinApiMan (2)
  • frie-soptim (2)
  • SanPen (2)
  • Thijss (2)
  • leovsch (2)
  • Jonasvdbo (2)
  • wfjvdham (2)
  • scud-soptim (1)

Top Pull Request Authors

  • mgovers (455)
  • Jerry-Jinfeng-Guo (139)
  • nitbharambe (132)
  • TonyXiang8787 (103)
  • dependabot[bot] (101)
  • figueroa1395 (100)
  • Laurynas-Jagutis (43)
  • petersalemink95 (31)
  • zhen0427 (29)
  • power-grid-model-ci-bot[bot] (28)
  • leovsch (8)
  • scud-soptim (8)
  • emabre (6)
  • ekiwaka (4)
  • Copilot (4)

Top Issue Labels

  • feature (127)
  • improvement (42)
  • good first issue (37)
  • bug (32)
  • documentation (9)
  • wontfix (2)
  • help wanted (1)
  • question (1)
  • duplicate (1)

Top Pull Request Labels

  • improvement (296)
  • feature (227)
  • dependencies (172)
  • bug (135)
  • documentation (115)
  • github_actions (61)
  • do-not-merge (37)
  • python:uv (3)
  • javascript (3)
  • wontfix (2)

Package metadata

proxy.golang.org: github.com/powergridmodel/power-grid-model

proxy.golang.org: github.com/PowerGridModel/power-grid-model

pypi.org: power-grid-model

Python/C++ library for distribution power system analysis


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: 20.89831098476959