Merge branch 'main' into nro/switch_snapshot_CI_to_new_app

Author: rolnico

README.md

@@ -20,6 +20,8 @@ GraalVM to compile Java code to a native library.
 
 Latest version of the documentation with API reference and many code samples is [here](https://pypowsybl.readthedocs.io/).  
 
+To contribute to the documentation follow the instructions in the [documentation README](https://github.com/powsybl/pypowsybl/blob/main/docs/README.md) page.
+
 ## Notebooks
 
 Notebooks demonstrating PyPowSyBl features can be found in this [repository](https://github.com/powsybl/pypowsybl-notebooks).
@@ -92,7 +94,7 @@ That section is intended for developers who wish to build pypowsybl from the sou
 Requirements:
 
 - Maven >= 3.1
-- Cmake >= 3.14
+- Cmake >= 3.20
 - C++11 compiler
 - Python >= 3.8 for Linux, Windows and MacOS (amd64 and arm64)
 - [Oracle GraalVM Java 17](https://www.graalvm.org/downloads/)
@@ -133,25 +135,3 @@ To run linting inspection with `pylint`:
 ```bash
 pylint pypowsybl
 ```
-
-## Contribute to documentation
-
-To run the tests included in the documentation:
-
-```bash
-cd docs/
-make doctest
-```
-
-And then, to build the documentation:
-
-```bash
-make html
-```
-
-Web pages are generated in repository _build/html/ for preview before opening a pull request.
-You can for example open it with firefox browser:
-
-```bash
-firefox _build/html/index.html
-```

cpp/CMakeLists.txt

@@ -4,7 +4,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 project(pypowsybl)
 
 set(CMAKE_CXX_STANDARD 17)

cpp/powsybl-cpp/CMakeLists.txt

@@ -4,7 +4,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 project(powsybl-cpp)
 
 set(CMAKE_CXX_STANDARD 17)

cpp/powsybl-cpp/powsybl-cpp.cpp

@@ -722,11 +722,11 @@ std::vector<std::string> getMatrixMultiSubstationSvgAndMetadata(const JavaHandle
     return svgAndMetadata.get();
 }
 
-void writeNetworkAreaDiagramSvg(const JavaHandle& network, const std::string& svgFile, const std::string& metadataFile, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions) {
+void writeNetworkAreaDiagramSvg(const JavaHandle& network, const std::string& svgFile, const std::string& metadataFile, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions, dataframe* branch_labels) {
     auto c_parameters = parameters.to_c_struct();
     ToCharPtrPtr voltageLevelIdPtr(voltageLevelIds);
     PowsyblCaller::get()->callJava(::writeNetworkAreaDiagramSvg, network, (char*) svgFile.data(), (char*) metadataFile.data(),
-        voltageLevelIdPtr.get(), voltageLevelIds.size(), depth, highNominalVoltageBound, lowNominalVoltageBound, c_parameters.get(), fixed_positions);
+        voltageLevelIdPtr.get(), voltageLevelIds.size(), depth, highNominalVoltageBound, lowNominalVoltageBound, c_parameters.get(), fixed_positions, branch_labels);
 }
 
 std::string getNetworkAreaDiagramSvg(const JavaHandle& network, const std::vector<std::string>&  voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters) {
@@ -735,10 +735,10 @@ std::string getNetworkAreaDiagramSvg(const JavaHandle& network, const std::vecto
     return toString(PowsyblCaller::get()->callJava<char*>(::getNetworkAreaDiagramSvg, network, voltageLevelIdPtr.get(), voltageLevelIds.size(), depth, highNominalVoltageBound, lowNominalVoltageBound, c_parameters.get()));
 }
 
-std::vector<std::string> getNetworkAreaDiagramSvgAndMetadata(const JavaHandle& network, const std::vector<std::string>&  voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions) {
+std::vector<std::string> getNetworkAreaDiagramSvgAndMetadata(const JavaHandle& network, const std::vector<std::string>&  voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions, dataframe* branch_labels) {
     auto c_parameters = parameters.to_c_struct();
     ToCharPtrPtr voltageLevelIdPtr(voltageLevelIds);
-    auto svgAndMetadataArrayPtr = PowsyblCaller::get()->callJava<array*>(::getNetworkAreaDiagramSvgAndMetadata, network, voltageLevelIdPtr.get(), voltageLevelIds.size(), depth, highNominalVoltageBound, lowNominalVoltageBound, c_parameters.get(), fixed_positions);
+    auto svgAndMetadataArrayPtr = PowsyblCaller::get()->callJava<array*>(::getNetworkAreaDiagramSvgAndMetadata, network, voltageLevelIdPtr.get(), voltageLevelIds.size(), depth, highNominalVoltageBound, lowNominalVoltageBound, c_parameters.get(), fixed_positions, branch_labels);
     ToStringVector svgAndMetadata(svgAndMetadataArrayPtr);
     return svgAndMetadata.get();
 }
@@ -1680,8 +1680,8 @@ JavaHandle createDefaultRaoParameters() {
     return pypowsybl::PowsyblCaller::get()->callJava<JavaHandle>(::createDefaultRaoParameters);
 }
 
-JavaHandle createGrid2opBackend(const JavaHandle& networkHandle, bool considerOpenBranchReactiveFlow, int busesPerVoltageLevel, bool connectAllElementsToFirstBus) {
-    return pypowsybl::PowsyblCaller::get()->callJava<JavaHandle>(::createGrid2opBackend, networkHandle, considerOpenBranchReactiveFlow, busesPerVoltageLevel, connectAllElementsToFirstBus);
+JavaHandle createGrid2opBackend(const JavaHandle& networkHandle, bool considerOpenBranchReactiveFlow, bool checkIsolatedAndDisconnectedInjections, int busesPerVoltageLevel, bool connectAllElementsToFirstBus) {
+    return pypowsybl::PowsyblCaller::get()->callJava<JavaHandle>(::createGrid2opBackend, networkHandle, considerOpenBranchReactiveFlow, checkIsolatedAndDisconnectedInjections, busesPerVoltageLevel, connectAllElementsToFirstBus);
 }
 
 void freeGrid2opBackend(const JavaHandle& backendHandle) {

cpp/powsybl-cpp/powsybl-cpp.h

@@ -579,11 +579,11 @@ std::vector<std::string> getMatrixMultiSubstationSvgAndMetadata(const JavaHandle
 
 std::vector<std::string> getSingleLineDiagramComponentLibraryNames();
 
-void writeNetworkAreaDiagramSvg(const JavaHandle& network, const std::string& svgFile, const std::string& metadataFile, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions);
+void writeNetworkAreaDiagramSvg(const JavaHandle& network, const std::string& svgFile, const std::string& metadataFile, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions, dataframe* branch_labels);
 
 std::string getNetworkAreaDiagramSvg(const JavaHandle& network, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters);
 
-std::vector<std::string> getNetworkAreaDiagramSvgAndMetadata(const JavaHandle& network, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions);
+std::vector<std::string> getNetworkAreaDiagramSvgAndMetadata(const JavaHandle& network, const std::vector<std::string>& voltageLevelIds, int depth, double highNominalVoltageBound, double lowNominalVoltageBound, const NadParameters& parameters, dataframe* fixed_positions, dataframe* branch_labels);
 
 std::vector<std::string> getNetworkAreaDiagramDisplayedVoltageLevels(const JavaHandle& network, const std::vector<std::string>& voltageLevelIds, int depth);
 
@@ -855,7 +855,7 @@ JavaHandle getRaoResult(const JavaHandle& raoContext);
 RaoComputationStatus getRaoResultStatus(const JavaHandle& raoResult);
 JavaHandle createDefaultRaoParameters();
 
-JavaHandle createGrid2opBackend(const JavaHandle& networkHandle, bool considerOpenBranchReactiveFlow, int busesPerVoltageLevel, bool connectAllElementsToFirstBus);
+JavaHandle createGrid2opBackend(const JavaHandle& networkHandle, bool considerOpenBranchReactiveFlow, bool checkIsolatedAndDisconnectedInjections, int busesPerVoltageLevel, bool connectAllElementsToFirstBus);
 void freeGrid2opBackend(const JavaHandle& backendHandle);
 std::vector<std::string> getGrid2opStringValue(const JavaHandle& backendHandle, Grid2opStringValueType valueType);
 array* getGrid2opIntegerValue(const JavaHandle& backendHandle, Grid2opIntegerValueType valueType);

cpp/pypowsybl-cpp/CMakeLists.txt

@@ -4,7 +4,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 project(pypowsybl-cpp)
 
 # Enable static linkage to prevent any future runtime binary compatibility issue

cpp/pypowsybl-cpp/bindings.cpp

@@ -685,13 +685,15 @@ PYBIND11_MODULE(_pypowsybl, m) {
 
     m.def("write_network_area_diagram_svg", &pypowsybl::writeNetworkAreaDiagramSvg, "Write network area diagram SVG",
           py::arg("network"), py::arg("svg_file"), py::arg("metadata_file"), py::arg("voltage_level_ids"),
-          py::arg("depth"), py::arg("high_nominal_voltage_bound"), py::arg("low_nominal_voltage_bound"), py::arg("nad_parameters"), py::arg("fixed_positions"));
+          py::arg("depth"), py::arg("high_nominal_voltage_bound"), py::arg("low_nominal_voltage_bound"), py::arg("nad_parameters"), py::arg("fixed_positions"),
+          py::arg("branch_labels"));
 
     m.def("get_network_area_diagram_svg", &pypowsybl::getNetworkAreaDiagramSvg, "Get network area diagram SVG as a string",
           py::arg("network"), py::arg("voltage_level_ids"), py::arg("depth"), py::arg("high_nominal_voltage_bound"), py::arg("low_nominal_voltage_bound"), py::arg("nad_parameters"));
 
     m.def("get_network_area_diagram_svg_and_metadata", &pypowsybl::getNetworkAreaDiagramSvgAndMetadata, "Get network area diagram SVG and its metadata as a list of strings",
-          py::arg("network"), py::arg("voltage_level_ids"), py::arg("depth"), py::arg("high_nominal_voltage_bound"), py::arg("low_nominal_voltage_bound"), py::arg("nad_parameters"), py::arg("fixed_positions"));
+          py::arg("network"), py::arg("voltage_level_ids"), py::arg("depth"), py::arg("high_nominal_voltage_bound"), py::arg("low_nominal_voltage_bound"), py::arg("nad_parameters"), py::arg("fixed_positions"),
+          py::arg("branch_labels"));
 
     m.def("get_network_area_diagram_displayed_voltage_levels", &pypowsybl::getNetworkAreaDiagramDisplayedVoltageLevels, "Get network area diagram displayed voltage level",
           py::arg("network"), py::arg("voltage_level_ids"), py::arg("depth"));
@@ -1179,18 +1181,23 @@ PYBIND11_MODULE(_pypowsybl, m) {
             .value("LOAD_P", Grid2opDoubleValueType::LOAD_P)
             .value("LOAD_Q", Grid2opDoubleValueType::LOAD_Q)
             .value("LOAD_V", Grid2opDoubleValueType::LOAD_V)
+            .value("LOAD_ANGLE", Grid2opDoubleValueType::LOAD_ANGLE)
             .value("GENERATOR_P", Grid2opDoubleValueType::GENERATOR_P)
             .value("GENERATOR_Q", Grid2opDoubleValueType::GENERATOR_Q)
             .value("GENERATOR_V", Grid2opDoubleValueType::GENERATOR_V)
+            .value("GENERATOR_ANGLE", Grid2opDoubleValueType::GENERATOR_ANGLE)
             .value("SHUNT_P", Grid2opDoubleValueType::SHUNT_P)
             .value("SHUNT_Q", Grid2opDoubleValueType::SHUNT_Q)
             .value("SHUNT_V", Grid2opDoubleValueType::SHUNT_V)
+            .value("SHUNT_ANGLE", Grid2opDoubleValueType::SHUNT_ANGLE)
             .value("BRANCH_P1", Grid2opDoubleValueType::BRANCH_P1)
             .value("BRANCH_P2", Grid2opDoubleValueType::BRANCH_P2)
             .value("BRANCH_Q1", Grid2opDoubleValueType::BRANCH_Q1)
             .value("BRANCH_Q2", Grid2opDoubleValueType::BRANCH_Q2)
             .value("BRANCH_V1", Grid2opDoubleValueType::BRANCH_V1)
             .value("BRANCH_V2", Grid2opDoubleValueType::BRANCH_V2)
+            .value("BRANCH_ANGLE1", Grid2opDoubleValueType::BRANCH_ANGLE1)
+            .value("BRANCH_ANGLE2", Grid2opDoubleValueType::BRANCH_ANGLE2)
             .value("BRANCH_I1", Grid2opDoubleValueType::BRANCH_I1)
             .value("BRANCH_I2", Grid2opDoubleValueType::BRANCH_I2)
             .value("BRANCH_PERMANENT_LIMIT_A", Grid2opDoubleValueType::BRANCH_PERMANENT_LIMIT_A);
@@ -1209,7 +1216,7 @@ PYBIND11_MODULE(_pypowsybl, m) {
             .value("UPDATE_BRANCH_BUS2", Grid2opUpdateIntegerValueType::UPDATE_BRANCH_BUS2);
 
     m.def("create_grid2op_backend", &pypowsybl::createGrid2opBackend, "Create a Grid2op backend", py::arg("network"),
-          py::arg("consider_open_branch_reactive_flow"), py::arg("buses_per_voltage_level"), py::arg("connect_all_elements_to_first_bus"));
+          py::arg("consider_open_branch_reactive_flow"), py::arg("check_isolated_and_disconnected_injections"), py::arg("buses_per_voltage_level"), py::arg("connect_all_elements_to_first_bus"));
     m.def("free_grid2op_backend", &pypowsybl::freeGrid2opBackend, "Free a Grid2op backend", py::arg("backend"));
     m.def("get_grid2op_string_value", &pypowsybl::getGrid2opStringValue, "From a Grid2op backend get a string value vector", py::arg("backend"), py::arg("value_type"));
     m.def("get_grid2op_integer_value", &::pyGetGrid2opIntegerValue, "From a Grid2op backend get a integer value vector", py::arg("backend"), py::arg("value_type"));

cpp/pypowsybl-java/CMakeLists.txt

@@ -4,7 +4,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 project(pypowsybl-java)
 
 set(CMAKE_CXX_STANDARD 17)

cpp/pypowsybl-java/powsybl-api.h

@@ -494,18 +494,23 @@ typedef enum {
     LOAD_P = 0,
     LOAD_Q,
     LOAD_V,
+    LOAD_ANGLE,
     GENERATOR_P,
     GENERATOR_Q,
     GENERATOR_V,
+    GENERATOR_ANGLE,
     SHUNT_P,
     SHUNT_Q,
     SHUNT_V,
+    SHUNT_ANGLE,
     BRANCH_P1,
     BRANCH_P2,
     BRANCH_Q1,
     BRANCH_Q2,
     BRANCH_V1,
     BRANCH_V2,
+    BRANCH_ANGLE1,
+    BRANCH_ANGLE2,
     BRANCH_I1,
     BRANCH_I2,
     BRANCH_PERMANENT_LIMIT_A,

docs/README.md

@@ -0,0 +1,49 @@
+# PyPowSyBl documentation
+
+These are the documentation sources for PyPowSyBl features.
+
+Please keep them up to date with your developments.  
+They are published on pypowsybl.readthedocs.io and pull requests are built and previewed automatically.
+
+## Run
+
+To run the tests included in the documentation:
+
+```bash
+make doctest
+```
+
+## Build the documentation
+
+When modifying the website content, you can easily preview the result on your PC.
+
+Navigate to the `docs` directory of the project and run the following commands:
+~~~bash
+cd docs
+~~~
+Install the requirements the first time:
+~~~bash
+pip install -r requirements.txt
+~~~
+Build the documentation:
+~~~bash
+sphinx-build -a . _build/html
+~~~
+Or
+~~~bash
+make html
+~~~
+Or to build the documentation in latex format:
+~~~bash
+make latexpdf
+~~~
+
+## Preview the result
+
+For html format, web pages are generated in repository `_build/html` and can be previewed opening a pull request.
+You can for example open it with firefox browser:
+
+```bash
+firefox _build/html/index.html
+```
+