Skip to content

Latest commit

 

History

History
121 lines (85 loc) · 7.16 KB

README.md

File metadata and controls

121 lines (85 loc) · 7.16 KB
Raw

PyPI version Anaconda-Server Badge License: MPL2.0 Downloads Downloads

Build and Test C++ and Python Check Code Quality Clang Tidy REUSE Compliance Check docs

Quality Gate Status Coverage Maintainability Rating Reliability Rating Security Rating Vulnerabilities

Nightly build

DOI

Power Grid Model

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

See the power-grid-model documentation for more information. 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: [email protected]

Installation

Install from PyPI

You can directly install the package from PyPI.

pip install power-grid-model

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

Build and install from Source

To install the library from source, refer to the Build Guide.

Examples

Please refer to Examples for more detailed examples for power flow and state estimation. Notebooks for validating the input data and exporting input/output data are also included.

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 CODE_OF_CONDUCT, CONTRIBUTING, PROJECT GOVERNANCE and RELEASE for details on the process for submitting pull requests to us.

Visit Contribute for a list of good first issues in this repo.

Citations

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

DOI

@software{Xiang_PowerGridModel_power-grid-model,
  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry 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 = {CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution},
  title = {Power grid model: A high-performance distribution grid calculation library},
  year = {2023},
  volume={2023},
  number = {},
  pages={1-5}
}

Contact

Please read SUPPORT for how to connect and get into contact with the Power Grid Model project.