PyPowSyBl

A Python library for modelling and simulating power grids by providing bindings to the powsybl Java framework.
https://github.com/powsybl/pypowsybl

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

cgmes load-flow loadflow power-flow power-system power-system-analysis power-system-simulation powerflow python

Keywords from Contributors

power-systems cim energy-system extensible groovy modular powsybl klu user-stories single-line-diagram

Last synced: about 17 hours ago
JSON representation

Repository metadata

A PowSyBl and Python integration based on GraalVM native image

Host: GitHub
URL: https://github.com/powsybl/pypowsybl
Owner: powsybl
License: mpl-2.0
Created: 2020-11-09T10:30:33.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2025-04-24T14:55:21.000Z (3 days ago)
Last Synced: 2025-04-25T13:05:38.983Z (1 day ago)
Topics: cgmes, load-flow, loadflow, power-flow, power-system, power-system-analysis, power-system-simulation, powerflow, python
Language: Java
Homepage:
Size: 12.1 MB
Stars: 64
Watchers: 20
Forks: 12
Open Issues: 80
Releases: 48
Metadata Files:
- Readme: README.md
- License: LICENSE

PyPowSyBl

Python code quality :

Java code quality :

The PyPowSyBl project gives access PowSyBl Java framework to Python developers. This Python integration relies on
GraalVM to compile Java code to a native library.

Documentation

Latest version of the documentation with API reference and many code samples is here.

To contribute to the documentation follow the instructions in the documentation README page.

Notebooks

Notebooks demonstrating PyPowSyBl features can be found in this repository.

Installation

PyPowSyBl is released on PyPi for Python 3.8 to 3.12, on Linux, Windows and MacOS.

First, make sure you have an up-to-date version of pip and setuptools:

pip install --upgrade setuptools pip

Then you can install PyPowSyBl using pip:

pip install pypowsybl

Getting started

First, we have to import pypowsybl:

import pypowsybl as pp

We can create an IEEE 14 buses network and run a load flow computation:

n = pp.network.create_ieee14()
results = pp.loadflow.run_ac(n)
print(results)

[ComponentResult(connected_component_num=0, synchronous_component_num=0, status=CONVERGED, status_text=CONVERGED, iteration_count=3, reference_bus_id='VL1_0', slack_bus_results=[SlackBusResult(id='VL1_0', active_power_mismatch=-0.006730108618313579)], distributed_active_power=0.0)]

We can now get buses data (like any other network elements) as a Pandas dataframe:

buses = n.get_buses()
print(buses)

        v_mag  v_angle
VL1_0   1.060     0.00
VL2_0   1.045    -4.98
VL3_0   1.010   -12.72
VL4_0   1.019   -10.33
VL5_0   1.020    -8.78
VL6_0   1.070   -14.22
VL7_0   1.062   -13.37
VL8_0   1.090   -13.36
VL9_0   1.056   -14.94
VL10_0  1.051   -15.10
VL11_0  1.057   -14.79
VL12_0  1.055   -15.07
VL13_0  1.050   -15.16
VL14_0  1.036   -16.04

This is just a quick appetizer of PyPowSyBl features. PyPowsybl provides a lot more features:
security analysis, sensitivity analysis, handling of multiple file formats (including CGMES),
substation and network diagrams generation, ...
For more details and examples, go to the documentation and Jupyter notebooks.

Build from sources

That section is intended for developers who wish to build pypowsybl from the sources in this repository.

Requirements:

Maven >= 3.1
Cmake >= 3.20
C++11 compiler
Python >= 3.8 for Linux, Windows and MacOS (amd64 and arm64)
Oracle GraalVM Java 17

To build from sources and install PyPowSyBl package:

git clone https://github.com/powsybl/pypowsybl.git
export JAVA_HOME=<path to GraalVM>
pip install --upgrade setuptools pip
pip install -r requirements.txt
pip install .

While developing, you may find it convenient to use the developer (or editable)
mode of installation:

pip install -e .
# or, to build the C extension with debug symbols:
python setup.py build --debug develop --user

Please refer to pip and setuptools documentations for more information.

To run unit tests:

pytest tests

To run static type checking with mypy:

mypy -p pypowsybl

To run linting inspection with pylint:

pylint pypowsybl

Owner metadata

Name: PowSyBl
Login: powsybl
Email:
Kind: organization
Description: Power System Blocks
Website: https://www.powsybl.org
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/29916668?v=4
Repositories: 40
Last ynced at: 2023-03-02T12:15:33.356Z
Profile URL: https://github.com/powsybl

GitHub Events

Total

Fork event: 2
Create event: 102
Release event: 4
Issues event: 46
Watch event: 11
Delete event: 82
Member event: 3
Issue comment event: 827
Push event: 586
Gollum event: 2
Pull request review comment event: 103
Pull request event: 181
Pull request review event: 190

Last Year

Fork event: 2
Create event: 102
Release event: 4
Issues event: 46
Watch event: 11
Delete event: 82
Member event: 3
Issue comment event: 827
Push event: 586
Gollum event: 2
Pull request review comment event: 103
Pull request event: 181
Pull request review event: 190

Committers metadata

Last synced: 4 days ago

Total Commits: 724
Total Committers: 33
Avg Commits per committer: 21.939
Development Distribution Score (DDS): 0.703

Commits in past year: 182
Committers in past year: 20
Avg Commits per committer in past year: 9.1
Development Distribution Score (DDS) in past year: 0.736

Name	Email	Commits
Geoffroy Jamgotchian	g**n@r**m	215
EtienneLt	3****t	168
Sylvain Leclerc	s**c@r**m	100
HugoKulesza	9****a	52
Coline Piloquet	5****t	31
Bertrand Rix	b**x@g**m	24
Christian Biasuzzi	c**i@s**t	24
jeandemanged	d**e@a**m	23
yichen88	3****8	21
Sophie Frasnedo	9****s	12
Florian Dupuy	6****p	10
Choco	9****t	6
Lisrte	l**l@r**m	4
OpenSuze	4****e	4
Clément Leclerc	c**c@r**m	3
Peter Mitri	p**i@r**m	3
alicecaron	a**n@r**m	3
DONNOT Benjamin	b**t@r**m	3
Naledi	1****8	2
Nicolas Pierre	1****r	2
Nicolas Rol	n**l@r**m	2
pjeanmarie	7****e	1
phiedw	p**6@h**r	1
p-arvy	1****y	1
Thomas ADAM	5****0	1
Olivier Perrin	o**n@r**m	1
Michał Marszal	f****l	1
Mathieu BAGUE	m**e@g**m	1
Massimo Ferraro	m**o@t**u	1
MartinBelthle	1****e	1
and 3 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 115
Total pull requests: 434
Average time to close issues: 4 months
Average time to close pull requests: 22 days
Total issue authors: 34
Total pull request authors: 31
Average comments per issue: 1.67
Average comments per pull request: 1.0
Merged pull request: 343
Bot issues: 0
Bot pull requests: 0

Past year issues: 61
Past year pull requests: 233
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 11 days
Past year issue authors: 21
Past year pull request authors: 21
Past year average comments per issue: 1.0
Past year average comments per pull request: 1.36
Past year merged pull request: 182
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/powsybl/pypowsybl

Top Issue Authors

sylvlecl (19)
HugoKulesza (14)
AnkurArohi (11)
BDonnot (11)
nicow-elia (8)
alicecaron (5)
colinepiloquet (5)
EtienneLt (4)
annetill (4)
jeandemanged (4)
unetablettedechocolat (3)
So-Fras (2)
tso-martin (2)
adeledesmoutisartelys (2)
flo-dup (2)

Top Pull Request Authors

EtienneLt (105)
geofjamg (97)
HugoKulesza (54)
colinepiloquet (29)
jeandemanged (26)
obrix (19)
So-Fras (14)
CBiasuzzi (14)
unetablettedechocolat (7)
flo-dup (7)
AnkurArohi (7)
Lisrte (7)
OpenSuze (6)
rolnico (6)
nao1345678 (6)

Top Issue Labels

bug (23)
enhancement (9)
Release 06/2025 (8)
PR: next-release (4)
December 2024 release (3)
Release 03/2025 (3)
status: needs-design (2)
status: in-progress (2)
documentation (2)
help wanted (1)
Epic (1)
performance (1)

Top Pull Request Labels

status: ready to be merged (87)
status: ready-for-review (36)
PR: next-release (26)
documentation (19)
breaking change (14)
Release 03/2025 (13)
bug (12)
December 2024 release (9)
status: in-progress (6)
Release 06/2025 (6)
do not merge (3)
help wanted (2)
status: conflict with main (1)
status: does not compile (1)
wontfix (1)
status: needs-design (1)
enhancement (1)

Package metadata

Total packages: 3
Total downloads:
- pypi: 11,362 last-month
Total dependent packages: 4 (may contain duplicates)
Total dependent repositories: 1 (may contain duplicates)
Total versions: 78
Total maintainers: 4

pypi.org: pypowsybl

A PowSyBl Python API

Homepage: https://github.com/powsybl/pypowsybl
Documentation: https://pypowsybl.readthedocs.io/
Licenses: Mozilla Public License 2.0 (MPL 2.0)
Latest release: 1.11.0 (published 20 days ago)
Last Synced: 2025-04-25T13:05:39.798Z (1 day ago)
Versions: 39
Dependent Packages: 4
Dependent Repositories: 1
Downloads: 11,188 Last month
Rankings:
- Downloads: 6.618%
- Dependent packages count: 7.303%
- Stargazers count: 10.458%
- Average: 11.81%
- Forks count: 12.604%
- Dependent repos count: 22.068%
Maintainers (3)

repo1.maven.org: com.powsybl:pypowsybl

A C interface to powsybl, for pypowsybl implementation

Homepage: https://www.powsybl.org
Documentation: https://appdoc.app/artifact/com.powsybl/pypowsybl/
Licenses: Mozilla Public License, Version 2.0
Latest release: 1.11.0 (published 20 days ago)
Last Synced: 2025-04-25T13:05:39.746Z (1 day ago)
Versions: 34
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Stargazers count: 23.871%
- Forks count: 29.031%
- Dependent repos count: 31.98%
- Average: 33.435%
- Dependent packages count: 48.86%

pypi.org: pypowsybl_grid2opbackend

Homepage:
Documentation: https://pypowsybl_grid2opbackend.readthedocs.io/
Licenses: mpl-2.0
Latest release: 1.0.0 (published over 1 year ago)
Last Synced: 2025-04-25T13:05:39.668Z (1 day ago)
Versions: 5
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 174 Last month
Rankings:
- Dependent packages count: 9.887%
- Average: 38.848%
- Dependent repos count: 67.809%
Maintainers (1)
- YoannJvr

Dependencies

java/pom.xml maven

ch.qos.logback:logback-classic 1.2.3 compile
ch.qos.logback:logback-core 1.2.3 compile
com.powsybl:powsybl-ieee-cdf-converter compile
com.powsybl:powsybl-dependencies 1.2.0 import
org.graalvm.nativeimage:svm 21.3.0 provided
org.graalvm.sdk:graal-sdk 21.3.0 provided
com.powsybl:powsybl-cgmes-conformity
com.powsybl:powsybl-cgmes-conversion
com.powsybl:powsybl-cgmes-model
com.powsybl:powsybl-config-classic
com.powsybl:powsybl-glsk-document-ucte
com.powsybl:powsybl-iidm-api
com.powsybl:powsybl-iidm-impl
com.powsybl:powsybl-iidm-reducer
com.powsybl:powsybl-iidm-test
com.powsybl:powsybl-iidm-xml-converter
com.powsybl:powsybl-loadflow-api
com.powsybl:powsybl-math-native 1.2.1
com.powsybl:powsybl-matpower-converter
com.powsybl:powsybl-network-area-diagram
com.powsybl:powsybl-open-loadflow
com.powsybl:powsybl-powerfactory-converter
com.powsybl:powsybl-powerfactory-dgs
com.powsybl:powsybl-psse-converter
com.powsybl:powsybl-single-line-diagram-core
com.powsybl:powsybl-tools
com.powsybl:powsybl-triple-store-impl-rdf4j
com.powsybl:powsybl-ucte-converter
org.apache.commons:commons-collections4 4.4
org.codehaus.janino:janino 3.1.0
org.mapdb:mapdb 3.0.8
org.slf4j:log4j-over-slf4j 1.7.30
com.powsybl:powsybl-commons test
com.powsybl:powsybl-math-native test
org.assertj:assertj-core 3.11.0 test
org.junit.jupiter:junit-jupiter-engine 5.5.2 test

requirements.txt pypi

coverage ==5.5
matplotlib *
mypy ==0.931
networkx *
pandas ==1.3.5
pandas-stubs ==1.2.0.47
prettytable ==2.0.0
pydata-sphinx-theme ==0.6.3
pylint ==2.12.2
pytest >=6.2.5
sphinx ==4.2.0
wheel ==0.37.1

setup.py pypi

networkx *
pandas *
prettytable *

.github/workflows/dev-ci.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
graalvm/setup-graalvm v1 composite
sonarsource/sonarcloud-github-action v1.6 composite

.github/workflows/full-ci.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
graalvm/setup-graalvm v1 composite
sonarsource/sonarcloud-github-action v1.6 composite

Score: 17.805142394667204

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

PyPowSyBl

Keywords

Keywords from Contributors

Repository metadata

README.md

PyPowSyBl

Documentation

Notebooks

Installation

Getting started

Build from sources

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: pypowsybl

repo1.maven.org: com.powsybl:pypowsybl

pypi.org: pypowsybl_grid2opbackend

Dependencies