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

Conversion tool for various grid data formats to power-grid-model
https://github.com/powergridmodel/power-grid-model-io

excel gaia python vision

Last synced: 19 days ago
JSON representation

Conversion tool for various grid data formats to power-grid-model

Host: GitHub
URL: https://github.com/powergridmodel/power-grid-model-io
Owner: PowerGridModel
License: mpl-2.0
Created: 2022-07-21T09:01:19.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2025-06-05T11:57:52.000Z (8 months ago)
Last Synced: 2025-06-08T14:02:00.565Z (8 months ago)
Topics: excel, gaia, python, vision
Language: Python
Homepage:
Size: 2.1 MB
Stars: 17
Watchers: 4
Forks: 9
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff

Awesome Lists containing this project

README

          

[![PyPI version](https://badge.fury.io/py/power-grid-model-io.svg?no-cache)](https://badge.fury.io/py/power-grid-model-io) 

[![Anaconda-Server Badge](https://anaconda.org/conda-forge/power-grid-model-io/badges/version.svg?no-cache)](https://anaconda.org/conda-forge/power-grid-model-io)

[![License: MIT](https://img.shields.io/badge/License-MPL2.0-informational.svg)](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE)

[![Downloads](https://static.pepy.tech/badge/power-grid-model-io)](https://pepy.tech/project/power-grid-model-io)

[![Downloads](https://static.pepy.tech/badge/power-grid-model-io/month)](https://pepy.tech/project/power-grid-model-io)

[![CI Build](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/ci.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/ci.yml)

[![docs](https://readthedocs.org/projects/power-grid-model-io/badge/)](https://power-grid-model-io.readthedocs.io/en/stable/)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=coverage)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-io&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-io)

[![Nightly build](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/nightly.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-io/actions/workflows/nightly.yml)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)

[![Power Grid Model logo](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#) 

# Power Grid Model Input/Output

`power-grid-model-io` can be used for various conversions to the

[power-grid-model](https://github.com/PowerGridModel/power-grid-model).

For detailed documentation, see [Read the Docs](https://power-grid-model-io.readthedocs.io/en/stable/index.html).

## Installation

### Install from PyPI

You can directly install the package from PyPI.

Although it is opt-in, it is recommended to use [`uv`](https://github.com/astral-sh/uv) as

your development environment manager.

```sh

uv pip install power-grid-model-io

```

### Install from Conda

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

```sh

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

```

## Examples

* [PGM JSON Example](https://github.com/PowerGridModel/power-grid-model-io/tree/main/docs/examples)

## License

This project is licensed under the Mozilla Public License, version 2.0 - see

[LICENSE](https://github.com/PowerGridModel/power-grid-model-io/blob/main/LICENSE) for details.

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

Visit [Contribute](https://github.com/PowerGridModel/power-grid-model-io/contribute) for a list of good first issues in

this repo.

## Citations

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

references.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8059257.svg)](https://zenodo.org/record/8059257)

```bibtex

@software{Xiang_PowerGridModel_power-grid-model-io,

  author = {Xiang, Yu and Salemink, Peter 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 {Contributors to the LF Energy project Power Grid Model}},

  doi = {10.5281/zenodo.8059257},

  license = {MPL-2.0},

  title = {{PowerGridModel/power-grid-model-io}},

  url = {https://github.com/PowerGridModel/power-grid-model-io}

}

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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

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

Awesome Lists containing this project

README