power-grid-model-ds

Data Science toolkit for Power Grid Model

https://github.com/powergridmodel/power-grid-model-ds

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.3%) to scientific vocabulary

Keywords from Contributors

interactive gaia powersystem packaging vision excel network-simulation hacking autograding embedded
Last synced: 6 months ago · JSON representation ·

Repository

Data Science toolkit for Power Grid Model

Basic Info
Statistics
  • Stars: 21
  • Watchers: 3
  • Forks: 5
  • Open Issues: 10
  • Releases: 43
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

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

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 CODEOFCONDUCT 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

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

Owner

  • Name: Power Grid Model
  • Login: PowerGridModel
  • Kind: organization
  • Email: dynamic.grid.calculation@alliander.com
  • Location: Netherlands

Steady-state distribution power system analysis

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 DS in your research work, please consider citing our library as below."

title: "PowerGridModel/power-grid-model-ds"
url: "https://github.com/PowerGridModel/power-grid-model-ds"
doi: "10.5281/zenodo.14825565"
license: "MPL-2.0"
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"
contact:
  - name: "LF Energy project Power Grid Model"
    email: "powergridmodel@lists.lfenergy.org"

references:
  - title: "PowerGridModel/power-grid-model"
    repository-code: "https://github.com/PowerGridModel/power-grid-model"
    doi: "10.5281/zenodo.8054429"
    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: "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"

  - 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-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"

GitHub Events

Total
  • Create event: 90
  • Issues event: 20
  • Release event: 31
  • Watch event: 19
  • Delete event: 44
  • Issue comment event: 190
  • Public event: 1
  • Push event: 188
  • Pull request review comment event: 82
  • Pull request review event: 123
  • Pull request event: 109
  • Fork event: 4
Last Year
  • Create event: 90
  • Issues event: 20
  • Release event: 31
  • Watch event: 19
  • Delete event: 44
  • Issue comment event: 190
  • Public event: 1
  • Push event: 188
  • Pull request review comment event: 82
  • Pull request review event: 123
  • Pull request event: 109
  • Fork event: 4

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 43
  • Total Committers: 10
  • Avg Commits per committer: 4.3
  • Development Distribution Score (DDS): 0.628
Past Year
  • Commits: 43
  • Committers: 10
  • Avg Commits per committer: 4.3
  • Development Distribution Score (DDS): 0.628
Top Committers
Name Email Commits
Thijs Baaijen 1****s 16
Vincent Koppen 5****n 7
Jaap Schouten 5****r 7
Martijn Govers m****s@h****m 6
Peter Salemink 6****5 2
dependabot[bot] 4****] 1
Santiago Figueroa Manrique f****5@g****m 1
Marnix van Lieshout 4****t 1
Jonas van den Bogaard 3****o 1
Irena Dukovska 4****k 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 18
  • Total pull requests: 115
  • Average time to close issues: 5 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 6
  • Total pull request authors: 11
  • Average comments per issue: 0.33
  • Average comments per pull request: 1.03
  • Merged pull requests: 86
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 18
  • Pull requests: 115
  • Average time to close issues: 5 days
  • Average time to close pull requests: 7 days
  • Issue authors: 6
  • Pull request authors: 11
  • Average comments per issue: 0.33
  • Average comments per pull request: 1.03
  • Merged pull requests: 86
  • Bot issues: 0
  • Bot pull requests: 3
Top Authors
Issue Authors
  • Thijss (11)
  • mgovers (3)
  • petersalemink95 (1)
  • figueroa1395 (1)
  • Bramtimm (1)
  • nitbharambe (1)
Pull Request Authors
  • Thijss (53)
  • jaapschoutenalliander (19)
  • mgovers (14)
  • vincentkoppen (13)
  • petersalemink95 (4)
  • dependabot[bot] (3)
  • MvLieshout (2)
  • figueroa1395 (2)
  • Jonasvdbo (2)
  • IrenaDk (2)
  • WhiteSymmetry (1)
Top Labels
Issue Labels
feature (7) improvement (6) bug (4)
Pull Request Labels
documentation (10) next-minor-release (7) dependencies (5) bug (5) improvement (4) v1.1 (4) do-not-merge (1) github_actions (1)

Dependencies

.github/workflows/build-test-and-sonar.yml actions
  • SonarSource/sonarqube-scan-action v4 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • softprops/action-gh-release v2 composite
.github/workflows/check-blocking-labels.yml actions
.github/workflows/check-code-quality.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/dco-merge-group.yml actions
.github/workflows/nightly.yml actions
.github/workflows/reuse-compliance.yml actions
  • actions/checkout v4 composite
  • fsfe/reuse-action v5 composite
pyproject.toml pypi
  • numpy >=1.21
  • power-grid-model >=1.7
  • rustworkx >= 0.15.1
setup.py pypi
.github/workflows/citations.yml actions
  • actions/checkout v4 composite
  • dieghernan/cff-validator v4 composite