index.md

Power Grid Model IO

:alt: pgm_logo
:width: 300px
:align: right

Power Grid Model IO is a tool to convert grid data to and from the native data format of power-grid-model. Currently, conversions from Vision excel exports is possible. Pandapower conversions are under development.

Install from PyPI

You can directly install the package from PyPI.

pip install power-grid-model-io

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

Citations

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

Contents

Detailed contents of the documentation are structured as follows.

:caption: "Installation"
:maxdepth: 2
quickstart.md

:caption: "Converters"
:maxdepth: 2
converters/converter.md
converters/tabular_converter.md
converters/vision_converter.md
converters/pandapower_converter.md

:caption: "Examples"
:maxdepth: 2
examples/pgm_json_example.ipynb
examples/vision_example.ipynb
examples/pandapower_example.ipynb

:caption: "API Documentation"
:maxdepth: 4
power_grid_model_io

:caption: "Contribution"
:maxdepth: 2
contribution/CODE_OF_CONDUCT.md
contribution/CONTRIBUTING.md
contribution/GOVERNANCE.md

:caption: "Release and Support"
:maxdepth: 2
release_and_support/RELEASE.md
release_and_support/SUPPORT.md
release_and_support/CITATION.md