:alt: pgm_logo
:width: 300px
:align: right
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
For various conversions to the power-grid-model, refer to the power-grid-model-io 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
You can directly install the package from PyPI.
pip install power-grid-model
If you are using conda
, you can directly install the package from conda-forge
channel.
conda install -c conda-forge power-grid-model
To install the library from source, refer to the Build Guide.
If you are using Power Grid Model in your research work, please consider citing our library using the references in Citation
Detailed contents of the documentation are structured as follows.
:maxdepth: 2
self
quickstart
:caption: "User Manual"
:maxdepth: 2
user_manual/data-model
user_manual/dataset-terminology
user_manual/components
user_manual/calculations
user_manual/performance-guide
user_manual/data-validator
user_manual/model-validation
user_manual/serialization
:caption: "API Reference"
:maxdepth: 2
api_reference/python-api-reference
api_reference/power-grid-model-c-api-reference
:caption: "Examples"
:maxdepth: 2
examples/Power Flow Example.ipynb
examples/Serialization Example.ipynb
examples/State Estimation Example.ipynb
examples/Short Circuit Example.ipynb
examples/Validation Examples.ipynb
examples/Make Test Dataset.ipynb
:caption: "Advanced documentation"
:maxdepth: 2
advanced_documentation/native-data-interface
advanced_documentation/build-guide
advanced_documentation/c-api
advanced_documentation/core-design
:caption: "Contribution"
:maxdepth: 2
contribution/CODE_OF_CONDUCT.md
contribution/CONTRIBUTING.md
contribution/folder-structure.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