PyPowSyBl
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.
Notebooks
Notebooks demonstrating PyPowSyBl features can be found in this repository.
Installation
PyPowSyBl is released on PyPi.
First, make sure you have an up-to-date version of pip and setuptools:
pip3 install --upgrade setuptools pip --user
Then you can install PyPowSyBl using pip:
pip3 install pypowsybl --user
Build from sources
Requirements:
- Maven >= 3.1
- Cmake >= 3.14
- C++11 compiler
- Python >= 3.7
- GraalVM 21.2.0 with native image
To build from sources and install PyPowSyBl package:
git clone --recursive https://github.com/powsybl/pypowsybl.git
export JAVA_HOME=<path to GraalVM>
pip3 install --upgrade setuptools pip --user
pip3 install . --user
To run unit tests:
python3 -m unittest discover --start-directory tests
While developing, you may find it convenient to use the develop (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.
Contribute to documentation
To run the tests included in the documentation:
cd docs/
make doctest
And then, to build the documentation:
make html
firefox _build/html/index.html
Web pages are generated in repository _build/html/ for preview before openning a pull request.
Usage
First, we have to import pypowsybl:
import pypowsybl as pp
Then we can display the version of the PowSyBl modules:
pp.print_version()
Powsybl versions:
+-----------------------------+-----------------------+------------+------------------------------------------+-------------------------------+
| Repository name | Maven project version | Git branch | Git version | Build timestamp |
+-----------------------------+-----------------------+------------+------------------------------------------+-------------------------------+
| powsybl-open-loadflow | X.Y.Z | | | |
| powsybl-single-line-diagram | X.Y.Z | | | |
| powsybl-core | X.Y.Z | | | |
+-----------------------------+-----------------------+------------+------------------------------------------+-------------------------------+
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)
for result in results:
print(result)
LoadFlowComponentResult(component_num=0, status=CONVERGED, iteration_count=3, slack_bus_id='VL4_0', slack_bus_active_power_mismatch=-0.006081)
We can re-run the load flow computation in DC mode:
results = pp.loadflow.run_dc(n)
By default, the application read configs from ${HOME}/.itools/config.yml We can disable this with command :
pp.set_config_read(False)
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
To disconnect or reconnect a line:
n.disconnect('L1-2-1')
n.connect('L1-2-1')
To open or close a switch:
n.open_switch('a_switch')
n.close_switch('a_switch')
To go further, you can also load a case file instead of creating the IEEE 14 buses network:
n = pp.network.load('test.uct')
And dump the network to another format:
n.dump('test.xiidm', 'XIIDM')
We can generate a single line diagram for a voltage level in the SVG format:
n.write_single_line_diagram_svg('VL1', '/tmp/VL1.svg')
To run a security analysis and print results table:
sa = pp.security.create_analysis()
sa.add_single_element_contingency('L1-2-1', 'c1')
sa.add_single_element_contingency('L2-3-1', 'c2')
sa.add_multiple_elements_contingency(['L1-2-1', 'L1-5-1'], 'c3')
sa_result = sa.run_ac(n)
print(sa_result.get_table())
+----------------+-----------+--------------+----------------+------------+-------+------------+---------------------+-----------------+-------+------+
| Contingency ID | Status | Equipment ID | Equipment name | Limit type | Limit | Limit name | Acceptable duration | Limit reduction | Value | Side |
+----------------+-----------+--------------+----------------+------------+-------+------------+---------------------+-----------------+-------+------+
| c3 | CONVERGED | | | | | | | | | |
| c1 | CONVERGED | | | | | | | | | |
| c2 | CONVERGED | | | | | | | | | |
+----------------+-----------+--------------+----------------+------------+-------+------------+---------------------+-----------------+-------+------+
To run a sensitivity analysis and print post contingency sensitivity matrix (Pandas dataframe):
sa = pp.sensitivity.create_dc_analysis()
sa.add_single_element_contingency('L1-2-1')
sa.set_branch_flow_factor_matrix(['L1-5-1', 'L2-3-1'], ['B1-G', 'B2-G', 'B3-G'])
sa_result = sa.run(n)
df = sa_result.get_branch_flows_sensitivity_matrix('L1-2-1')
print(df)
L1-5-1 L2-3-1
B1-G 0.5 -0.084423
B2-G -0.5 0.084423
B3-G -0.5 -0.490385
![[Flow Decomposition] Update to Entsoe 2.1.0](https://avatars.githubusercontent.com/u/40593901?v=4)
![[Network modifications] Fix: remove compulsory attribute](https://avatars.githubusercontent.com/u/55250145?v=4)
1 Jan 20, 2022
13 Jul 21, 2022
8 Nov 9, 2022
81 Nov 26, 2022
4 Nov 9, 2022
3 Feb 2, 2022
352 Jan 6, 2023
240 Jan 6, 2023
163 Jan 5, 2023
27 Jan 4, 2023
2 Sep 8, 2022
1 Dec 23, 2021
1 Nov 24, 2021
45 Dec 20, 2022
3 Nov 3, 2022
886 Dec 27, 2022
115 Dec 10, 2022
1 Nov 14, 2022
1 Jan 13, 2022