Add JSON file content to ContingencyContainer (#959)

nao1345678 · web-flow · commit bae3dc51992c · 2025-04-07T10:28:04.000+02:00
Signed-off-by: Naledi EL CHEIKH &lt;naledi.elcheikh@rte-france.com&gt;
diff --git a/cpp/powsybl-cpp/powsybl-cpp.cpp b/cpp/powsybl-cpp/powsybl-cpp.cpp
@@ -761,6 +761,10 @@ void addContingency(const JavaHandle& analysisContext, const std::string& contin
     PowsyblCaller::get()->callJava(::addContingency, analysisContext, (char*) contingencyId.data(), elementIdPtr.get(), elementsIds.size());
 }
 
+void addContingencyFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath) {
+    PowsyblCaller::get()->callJava(::addContingencyFromJsonFile, analysisContext, (char*) jsonFilePath.data());
+}
+
 JavaHandle runSecurityAnalysis(const JavaHandle& securityAnalysisContext, const JavaHandle& network, const SecurityAnalysisParameters& parameters,
                                const std::string& provider, bool dc, JavaHandle* reportNode) {
     auto c_parameters = parameters.to_c_struct();
diff --git a/cpp/powsybl-cpp/powsybl-cpp.h b/cpp/powsybl-cpp/powsybl-cpp.h
@@ -594,6 +594,8 @@ JavaHandle createSecurityAnalysis();
 
 void addContingency(const JavaHandle& analysisContext, const std::string& contingencyId, const std::vector<std::string>& elementsIds);
 
+void addContingencyFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath);
+
 JavaHandle runSecurityAnalysis(const JavaHandle& securityAnalysisContext, const JavaHandle& network, const SecurityAnalysisParameters& parameters, const std::string& provider, bool dc, JavaHandle* reportNode);
 
 JavaHandle createSensitivityAnalysis();
diff --git a/cpp/pypowsybl-cpp/bindings.cpp b/cpp/pypowsybl-cpp/bindings.cpp
@@ -705,6 +705,9 @@ PYBIND11_MODULE(_pypowsybl, m) {
     m.def("add_contingency", &pypowsybl::addContingency, "Add a contingency to a security analysis or sensitivity analysis",
           py::arg("analysis_context"), py::arg("contingency_id"), py::arg("elements_ids"));
 
+    m.def("add_contingency_from_json_file", &pypowsybl::addContingencyFromJsonFile, "Add contingencies from JSON file.",
+          py::arg("analysis_context"), py::arg("path_to_json_file"));
+
     m.def("add_load_active_power_action", &pypowsybl::addLoadActivePowerAction, "Add a load active power remedial action",
           py::arg("analysis_context"), py::arg("action_id"), py::arg("load_id"), py::arg("is_relative"), py::arg("active_power"));
 
diff --git a/data/contingencies.json b/data/contingencies.json
@@ -0,0 +1,21 @@
+{
+  "type" : "default",
+  "version" : "1.0",
+  "name" : "list",
+  "contingencies" : [ {
+    "id" : "contingency",
+    "elements" : [ {
+      "id" : "NHV1_NHV2_1",
+      "type" : "BRANCH"
+    }, {
+      "id" : "NHV1_NHV2_2",
+      "type" : "BRANCH"
+    } ]
+  }, {
+    "id" : "contingency2",
+    "elements" : [ {
+      "id" : "GEN",
+      "type" : "GENERATOR"
+    } ]
+  } ]
+}
diff --git a/docs/user_guide/security.rst b/docs/user_guide/security.rst
@@ -143,4 +143,35 @@ The following operator strategy define the application of the switch action 'Swi
     >>> df.loc['Breaker contingency', 'OperatorStrategy1', 'LINE_S3S4']['p1'].item()
     240.00360040333226
 
-Results for the post remedial action state are available in the branch results indexed with the operator strategy unique id.
+Results for the post remedial action state are available in the branch results indexed with the operator strategy unique id.
+
+Adding input data from JSON files
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is possible to add the input data of a security analysis using JSON files.
+For now, only the contingencies can be added this way, using the `add_contingencies_from_json_file` method.
+An example of a valid JSON contingency file is the following :
+
+.. code-block:: JSON
+
+    {
+      "type" : "default",
+      "version" : "1.0",
+      "name" : "list",
+      "contingencies" : [ {
+        "id" : "contingency",
+        "elements" : [ {
+          "id" : "NHV1_NHV2_1",
+          "type" : "BRANCH"
+        }, {
+          "id" : "NHV1_NHV2_2",
+          "type" : "BRANCH"
+        } ]
+      }, {
+        "id" : "contingency2",
+        "elements" : [ {
+          "id" : "GEN",
+          "type" : "GENERATOR"
+        } ]
+      } ]
+    }
diff --git a/java/pypowsybl/src/main/java/com/powsybl/python/contingency/ContingencyContainer.java b/java/pypowsybl/src/main/java/com/powsybl/python/contingency/ContingencyContainer.java
@@ -7,6 +7,7 @@
  */
 package com.powsybl.python.contingency;
 
+import java.nio.file.Path;
 import java.util.List;
 
 /**
@@ -15,4 +16,6 @@
 public interface ContingencyContainer {
 
     void addContingency(String contingencyId, List<String> elementIds);
+
+    void addContingencyFromJsonFile(Path pathToJsonFile);
 }
diff --git a/java/pypowsybl/src/main/java/com/powsybl/python/contingency/ContingencyContainerImpl.java b/java/pypowsybl/src/main/java/com/powsybl/python/contingency/ContingencyContainerImpl.java
@@ -9,12 +9,12 @@
 
 import com.powsybl.commons.PowsyblException;
 import com.powsybl.contingency.*;
+import com.powsybl.contingency.contingency.list.ContingencyList;
 import com.powsybl.iidm.network.*;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.*;
 import java.util.stream.Collectors;
 
 /**
@@ -23,12 +23,18 @@
 public class ContingencyContainerImpl implements ContingencyContainer {
 
     private final Map<String, List<String>> elementIdsByContingencyId = new HashMap<>();
+    private Path pathToContingencyJsonFile = null;
 
     @Override
     public void addContingency(String contingencyId, List<String> elementIds) {
         elementIdsByContingencyId.put(contingencyId, elementIds);
     }
 
+    @Override
+    public void addContingencyFromJsonFile(Path pathToJsonFile) {
+        pathToContingencyJsonFile = pathToJsonFile;
+    }
+
     private static ContingencyElement createContingencyElement(Network network, String elementId) {
         Identifiable<?> identifiable = network.getIdentifiable(elementId);
         if (identifiable == null) {
@@ -67,6 +73,21 @@ private static ContingencyElement createContingencyElement(Network network, Stri
 
     protected List<Contingency> createContingencies(Network network) {
         List<Contingency> contingencies = new ArrayList<>(elementIdsByContingencyId.size());
+
+        if (pathToContingencyJsonFile != null) {
+            if (Files.exists(pathToContingencyJsonFile)) {
+                ContingencyList contingenciesList;
+                contingenciesList = ContingencyList.load(pathToContingencyJsonFile);
+
+                for (Contingency contingency : contingenciesList.getContingencies(network)) {
+                    contingencies.add(new Contingency(contingency.getId(), contingency.getElements()));
+                }
+            } else {
+                throw new PowsyblException("File not found: " + pathToContingencyJsonFile);
+            }
+
+        }
+
         for (Map.Entry<String, List<String>> e : elementIdsByContingencyId.entrySet()) {
             String contingencyId = e.getKey();
             List<String> elementIds = e.getValue();
diff --git a/java/pypowsybl/src/main/java/com/powsybl/python/security/SecurityAnalysisCFunctions.java b/java/pypowsybl/src/main/java/com/powsybl/python/security/SecurityAnalysisCFunctions.java
@@ -38,6 +38,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
@@ -136,6 +138,17 @@ public static void addContingency(IsolateThread thread, ObjectHandle contingency
         });
     }
 
+    @CEntryPoint(name = "addContingencyFromJsonFile")
+    public static void addContingencyFromJsonFile(IsolateThread thread, ObjectHandle contingencyContainerHandle, CCharPointer jsonFilePath,
+                                           PyPowsyblApiHeader.ExceptionHandlerPointer exceptionHandlerPtr) {
+        doCatch(exceptionHandlerPtr, () -> {
+            ContingencyContainer contingencyContainer = ObjectHandles.getGlobal().get(contingencyContainerHandle);
+            String stringPath = CTypeUtil.toString(jsonFilePath);
+            Path path = Paths.get(stringPath);
+            contingencyContainer.addContingencyFromJsonFile(path);
+        });
+    }
+
     private static void setPostContingencyResultInSecurityAnalysisResultPointer(PyPowsyblApiHeader.PostContingencyResultPointer contingencyPtr, PostContingencyResult postContingencyResult) {
         contingencyPtr.setContingencyId(CTypeUtil.toCharPtr(postContingencyResult.getContingency().getId()));
         contingencyPtr.setStatus(postContingencyResult.getStatus().ordinal());
diff --git a/java/pypowsybl/src/test/java/com/powsybl/python/contingency/ContingencyContainerTest.java b/java/pypowsybl/src/test/java/com/powsybl/python/contingency/ContingencyContainerTest.java
@@ -7,20 +7,30 @@
  */
 package com.powsybl.python.contingency;
 
+import com.google.common.jimfs.Configuration;
+import com.google.common.jimfs.Jimfs;
 import com.powsybl.contingency.*;
+import com.powsybl.iidm.network.Network;
 import com.powsybl.iidm.network.test.*;
+
 import org.junit.jupiter.api.Test;
 
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.Files;
 import java.util.List;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
  */
 class ContingencyContainerTest {
 
+    protected FileSystem fileSystem;
+
     @Test
     void testContingencyConverter() {
         var container1 = new ContingencyContainerImpl();
@@ -89,4 +99,19 @@ void testContingencyConverter() {
                 .hasOnlyOneElementSatisfying(c -> assertThat(c.getElements().get(0)).isInstanceOf(BatteryContingency.class));
     }
 
+    @Test
+    void testToAddContingencyFromJsonFile() throws IOException {
+        ContingencyContainerImpl container = new ContingencyContainerImpl();
+        Network network = EurostagTutorialExample1Factory.createWithFixedCurrentLimits();
+        fileSystem = Jimfs.newFileSystem(Configuration.unix());
+
+        Files.copy(getClass().getResourceAsStream("/contingencies.json"), fileSystem.getPath("/contingencies.json"));
+        container.addContingencyFromJsonFile(fileSystem.getPath("/contingencies.json"));
+        List<Contingency> contingencies = container.createContingencies(network);
+
+        assertFalse(contingencies.isEmpty());
+        assertEquals(2, contingencies.size());
+        assertEquals("contingency", contingencies.get(0).getId());
+        assertEquals("contingency2", contingencies.get(1).getId());
+    }
 }
diff --git a/java/pypowsybl/src/test/resources/contingencies.json b/java/pypowsybl/src/test/resources/contingencies.json
@@ -0,0 +1,21 @@
+{
+  "type" : "default",
+  "version" : "1.0",
+  "name" : "list",
+  "contingencies" : [ {
+    "id" : "contingency",
+    "elements" : [ {
+      "id" : "NHV1_NHV2_1",
+      "type" : "BRANCH"
+    }, {
+      "id" : "NHV1_NHV2_2",
+      "type" : "BRANCH"
+    } ]
+  }, {
+    "id" : "contingency2",
+    "elements" : [ {
+      "id" : "GEN",
+      "type" : "GENERATOR"
+    } ]
+  } ]
+}
diff --git a/pypowsybl/_pypowsybl.pyi b/pypowsybl/_pypowsybl.pyi
@@ -3,7 +3,6 @@ from typing import ClassVar, Dict, Iterator, List, Sequence, Optional, Union
 
 from numpy import ndarray
 
-
 class ArrayStruct:
     def __init__(self) -> None: ...
 
@@ -797,6 +796,7 @@ class RaoComputationStatus:
     def name(self) -> str: ...
 
 def add_contingency(analysis_context: JavaHandle, contingency_id: str, elements_ids: List[str]) -> None: ...
+def add_contingency_from_json_file(analysis_context: JavaHandle, path_to_json_file: str) -> None: ...
 def add_monitored_elements(security_analysis_context: JavaHandle, contingency_context_type: ContingencyContextType, branch_ids: List[str], voltage_level_ids: List[str], three_windings_transformer_ids: List[str], contingency_ids: List[str]) -> None: ...
 def add_load_active_power_action(security_analysis_context: JavaHandle, action_id: str, load_id: str, is_relative: bool, active_power: float) -> None: ...
 def add_load_reactive_power_action(security_analysis_context: JavaHandle, action_id: str, load_id: str, is_relative: bool, reactive_power: float) -> None: ...
@@ -1202,3 +1202,4 @@ def update_grid2op_integer_value(backend: JavaHandle, value_type: Grid2opUpdateI
 def check_grid2op_isolated_and_disconnected_injections(backend: JavaHandle) -> bool: ...
 
 def run_grid2op_loadflow(backend: JavaHandle, dc: bool, parameters: LoadFlowParameters) -> LoadFlowComponentResultArray: ...
+
diff --git a/pypowsybl/security/impl/contingency_container.py b/pypowsybl/security/impl/contingency_container.py
@@ -7,7 +7,6 @@
 from typing import List, Callable
 from pypowsybl import _pypowsybl
 
-
 class ContingencyContainer:
     def __init__(self, handle: _pypowsybl.JavaHandle):
         self._handle = handle
@@ -47,3 +46,13 @@ def add_single_element_contingencies(self, elements_ids: List[str],
         for element_id in elements_ids:
             contingency_id = contingency_id_provider(element_id) if contingency_id_provider else element_id
             _pypowsybl.add_contingency(self._handle, contingency_id, [element_id])
+
+    def add_contingencies_from_json_file(self, path_to_json_file: str) -> None:
+        """
+        Add contingencies from JSON file.
+
+        Args:
+            path_to_json_file: The path to the JSON file from which we extract the contingency list.
+        """
+
+        _pypowsybl.add_contingency_from_json_file(self._handle, path_to_json_file)
diff --git a/tests/test_security_analysis.py b/tests/test_security_analysis.py
@@ -11,6 +11,10 @@
 import pypowsybl.report as rp
 from pypowsybl._pypowsybl import ConditionType
 import re
+import pathlib
+
+TEST_DIR = pathlib.Path(__file__).parent
+DATA_DIR = TEST_DIR.parent.joinpath('data')
 
 
 @pytest.fixture(autouse=True)
@@ -408,6 +412,14 @@ def test_tie_line_contingency():
     sa_result = sa.run_ac(n)
     assert 'tie line contingency' in sa_result.post_contingency_results.keys()
 
+def test_add_contingencies_from_json_file():
+    n = pp.network.create_eurostag_tutorial_example1_network()
+    sa = pp.security.create_analysis()
+    sa.add_contingencies_from_json_file(str(DATA_DIR.joinpath('contingencies.json')))
+    sa_result = sa.run_ac(n)
+    assert 'contingency' in sa_result.post_contingency_results.keys()
+    assert 'contingency2' in sa_result.post_contingency_results.keys()
+
 def test_terminal_connection_action():
     n = pp.network.create_eurostag_tutorial_example1_network()
     sa = pp.security.create_analysis()
