https://github.com/powergridmodel/power-grid-model-ds
Data Science toolkit for Power Grid Model
https://github.com/powergridmodel/power-grid-model-ds
Last synced: 7 months ago
JSON representation
Data Science toolkit for Power Grid Model
- Host: GitHub
- URL: https://github.com/powergridmodel/power-grid-model-ds
- Owner: PowerGridModel
- License: mpl-2.0
- Created: 2024-12-09T14:31:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T08:15:42.000Z (7 months ago)
- Last Synced: 2025-06-16T09:24:45.626Z (7 months ago)
- Language: Python
- Homepage: https://power-grid-model-ds.readthedocs.io/en/stable/
- Size: 1.49 MB
- Stars: 19
- Watchers: 3
- Forks: 4
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
[](https://badge.fury.io/py/power-grid-model-ds)
[](https://github.com/PowerGridModel/power-grid-model-ds/blob/main/LICENSE)
[](https://pepy.tech/project/power-grid-model-ds)
[](https://pepy.tech/project/power-grid-model-ds)
[](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/ci.yml)
[](https://power-grid-model-ds.readthedocs.io/en/stable/)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
[](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/nightly.yml)
[](https://zenodo.org/record/14825565)
[](#)
# 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.
See the [power-grid-model-ds documentation](https://power-grid-model-ds.readthedocs.io/en/stable/) 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](https://github.com/PowerGridModel/power-grid-model-ds/blob/main/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](https://github.com/PowerGridModel/power-grid-model-ds/tree/main/LICENSES) directory.
## Contributing
Please read [CODE_OF_CONDUCT](https://github.com/PowerGridModel/.github/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/PowerGridModel/.github/blob/main/CONTRIBUTING.md) 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.
[](https://zenodo.org/record/14825565)
```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](https://github.com/PowerGridModel/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the Power Grid Model project.