Add operator strategies and remedial actions from a JSON file

.gitignore

@@ -58,6 +58,3 @@ build/*
 tests/_trial_temp/*
 
 *.orig
-
-# Documentation generated files (autosummary)
-docs/reference/api/

cpp/powsybl-cpp/powsybl-cpp.cpp

@@ -825,6 +825,15 @@ void addOperatorStrategy(const JavaHandle& analysisContext, std::string operator
         conditionType, subjectIdsPtr.get(), subjectIds.size(), violationTypesPtr.get(), violationTypesFilters.size());
 }
 
+void addActionFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath) {
+      PowsyblCaller::get()->callJava(::addActionFromJsonFile, analysisContext, (char*) jsonFilePath.data());
+}
+
+void addOperatorStrategyFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath) {
+      PowsyblCaller::get()->callJava(::addOperatorStrategyFromJsonFile, analysisContext, (char*) jsonFilePath.data());
+}
+
+
 ::zone* createZone(const std::string& id, const std::vector<std::string>& injectionsIds, const std::vector<double>& injectionsShiftKeys) {
     auto z = new ::zone;
     z->id = copyStringToCharPtr(id);

cpp/powsybl-cpp/powsybl-cpp.h

@@ -620,6 +620,10 @@ void addTerminalsConnectionAction(const JavaHandle& analysisContext, const std::
 void addOperatorStrategy(const JavaHandle& analysisContext, std::string operatorStrategyId, std::string contingencyId, const std::vector<std::string>& actionsIds,
                          condition_type conditionType, const std::vector<std::string>& subjectIds, const std::vector<violation_type>& violationTypesFilters);
 
+void addActionFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath);
+
+void addOperatorStrategyFromJsonFile(const JavaHandle& analysisContext, const std::string& jsonFilePath);
+
 void setZones(const JavaHandle& sensitivityAnalysisContext, const std::vector<::zone*>& zones);
 
 void addFactorMatrix(const JavaHandle& sensitivityAnalysisContext, std::string matrixId, const std::vector<std::string>& branchesIds,

cpp/pypowsybl-cpp/bindings.cpp

@@ -736,6 +736,12 @@ PYBIND11_MODULE(_pypowsybl, m) {
           py::arg("analysis_context"), py::arg("operator_strategy_id"), py::arg("contingency_id"), py::arg("action_ids"),
           py::arg("condition_type"), py::arg("subject_ids"), py::arg("violation_types"));
 
+    m.def("add_action_from_json_file", &pypowsybl::addActionFromJsonFile, "Add actions from JSON file.",
+          py::arg("analysis_context"), py::arg("path_to_json_file"));
+
+    m.def("add_operator_strategy_from_json_file", &pypowsybl::addOperatorStrategyFromJsonFile, "Add operator strategies from JSON file.",
+          py::arg("analysis_context"), py::arg("path_to_json_file"));
+
     py::enum_<pypowsybl::LimitType>(m, "LimitType")
             .value("ACTIVE_POWER", pypowsybl::LimitType::ACTIVE_POWER)
             .value("APPARENT_POWER", pypowsybl::LimitType::APPARENT_POWER)

data/ActionFileTestV1.0.json

@@ -0,0 +1,14 @@
+{
+  "version" : "1.0",
+  "actions" : [ {
+    "type" : "SWITCH",
+    "id" : "id1",
+    "switchId" : "S1VL2_LCC1_BREAKER",
+    "open" : true
+  }, {
+    "type" : "SWITCH",
+    "id" : "id2",
+    "switchId" : "S1VL2_BBS2_COUPLER_DISCONNECTOR",
+    "open" : true
+  }]
+}

data/OperatorStrategyFileTestV1.0.json

@@ -0,0 +1,15 @@
+{
+  "version" : "1.1",
+  "operatorStrategies" : [ {
+    "id" : "id1",
+    "contingencyContextType" : "SPECIFIC",
+    "contingencyId" : "contingency",
+    "conditionalActions" : [ {
+      "id" : "stage1",
+      "condition" : {
+        "type" : "TRUE_CONDITION"
+      },
+      "actionIds" : [ "id1", "id2" ]
+    } ]
+  }]
+}

docs/user_guide/security.rst

@@ -149,7 +149,8 @@ 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.
+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
@@ -175,3 +176,47 @@ An example of a valid JSON contingency file is the following :
         } ]
       } ]
     }
+
+
+From now on, it is possible to add the remedial actions using JSON files too, using the `add_actions_from_json_file` method.
+The following example is a valid JSON file input for this method :
+
+.. code-block:: JSON
+
+    {
+      "version" : "1.0",
+      "actions" : [ {
+        "type" : "SWITCH",
+        "id" : "id1",
+        "switchId" : "S1VL2_LCC1_BREAKER",
+        "open" : true
+      }, {
+        "type" : "SWITCH",
+        "id" : "id2",
+        "switchId" : "S1VL2_BBS2_COUPLER_DISCONNECTOR",
+        "open" : true
+      }]
+    }
+
+
+Additionally, you can add operator strategies from JSON data, using the `add_operator_strategies_from_json_file` method.
+The following example is a valid JSON file input for this method :
+
+.. code-block:: JSON
+
+    {
+      "version" : "1.1",
+      "operatorStrategies" : [ {
+        "id" : "id1",
+        "contingencyContextType" : "SPECIFIC",
+        "contingencyId" : "contingency",
+        "conditionalActions" : [ {
+          "id" : "stage1",
+          "condition" : {
+            "type" : "TRUE_CONDITION"
+          },
+          "actionIds" : [ "id1", "id2" ]
+        } ]
+      }]
+    }
+

java/pypowsybl/src/main/java/com/powsybl/python/security/SecurityAnalysisCFunctions.java

@@ -460,6 +460,17 @@ public static void addShuntCompensatorPositionAction(IsolateThread thread, Objec
         });
     }
 
+    @CEntryPoint(name = "addActionFromJsonFile")
+    public static void addActionFromJsonFile(IsolateThread thread, ObjectHandle securityAnalysisContextHandle,
+                                             CCharPointer jsonFilePath, PyPowsyblApiHeader.ExceptionHandlerPointer exceptionHandlerPtr) {
+        doCatch(exceptionHandlerPtr, () -> {
+            SecurityAnalysisContext analysisContext = ObjectHandles.getGlobal().get(securityAnalysisContextHandle);
+            String stringPath = CTypeUtil.toString(jsonFilePath);
+            Path path = Paths.get(stringPath);
+            analysisContext.addActionFromJsonFile(path);
+        });
+    }
+
     @CEntryPoint(name = "addTerminalsConnectionAction")
     public static void addTerminalsConnectionAction(IsolateThread thread, ObjectHandle securityAnalysisContextHandle,
                                                          CCharPointer actionId, CCharPointer elementId, PyPowsyblApiHeader.ThreeSideType side,
@@ -500,6 +511,17 @@ public static void addOperatorStrategy(IsolateThread thread, ObjectHandle securi
         });
     }
 
+    @CEntryPoint(name = "addOperatorStrategyFromJsonFile")
+    public static void addOperatorStrategyFromJsonFile(IsolateThread thread, ObjectHandle securityAnalysisContextHandle,
+                                             CCharPointer jsonFilePath, PyPowsyblApiHeader.ExceptionHandlerPointer exceptionHandlerPtr) {
+        doCatch(exceptionHandlerPtr, () -> {
+            SecurityAnalysisContext analysisContext = ObjectHandles.getGlobal().get(securityAnalysisContextHandle);
+            String stringPath = CTypeUtil.toString(jsonFilePath);
+            Path path = Paths.get(stringPath);
+            analysisContext.addOperatorStrategyFromJsonFile(path);
+        });
+    }
+
     private static Condition buildCondition(PyPowsyblApiHeader.ConditionType conditionType,
                                             CCharPointerPointer subjectIds, int subjectIdsCount,
                                             CIntPointer violationTypes, int violationTypesCount) {

java/pypowsybl/src/main/java/com/powsybl/python/security/SecurityAnalysisContext.java

@@ -8,6 +8,7 @@
 package com.powsybl.python.security;
 
 import com.powsybl.action.Action;
+import com.powsybl.action.ActionList;
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.contingency.ContingenciesProvider;
 import com.powsybl.iidm.network.Network;
@@ -16,7 +17,10 @@
 import com.powsybl.security.*;
 import com.powsybl.security.monitor.StateMonitor;
 import com.powsybl.security.strategy.OperatorStrategy;
+import com.powsybl.security.strategy.OperatorStrategyList;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -45,6 +49,26 @@ SecurityAnalysisResult run(Network network, SecurityAnalysisParameters securityA
         return report.getResult();
     }
 
+    void addActionFromJsonFile(Path path) {
+        if (Files.exists(path)) {
+            ActionList actionList;
+            actionList = ActionList.readJsonFile(path);
+            actions.addAll(actionList.getActions());
+        } else {
+            throw new SecurityException("No actions found in " + path);
+        }
+    }
+
+    void addOperatorStrategyFromJsonFile(Path path) {
+        if (Files.exists(path)) {
+            OperatorStrategyList operatorStrategyList;
+            operatorStrategyList = OperatorStrategyList.read(path);
+            operatorStrategies.addAll(operatorStrategyList.getOperatorStrategies());
+        } else {
+            throw new SecurityException("No operatorStrategies found in " + path);
+        }
+    }
+
     void addAction(Action action) {
         actions.add(action);
     }

java/pypowsybl/src/test/java/com/powsybl/python/security/SecurityAnalysisTest.java

@@ -23,6 +23,7 @@
 import org.assertj.core.data.Offset;
 import org.junit.jupiter.api.Test;
 
+import java.nio.file.FileSystem;
 import java.util.Collections;
 import java.util.List;
 
@@ -33,6 +34,8 @@
  */
 class SecurityAnalysisTest {
 
+    protected FileSystem fileSystem;
+
     @Test
     void testStateMonitors() {
         SecurityAnalysisContext analysisContext = new SecurityAnalysisContext();

java/pypowsybl/src/test/resources/ActionFileTestV1.0.json

@@ -0,0 +1,14 @@
+{
+  "version" : "1.0",
+  "actions" : [ {
+    "type" : "SWITCH",
+    "id" : "id1",
+    "switchId" : "S1VL1_LD1_BREAKER",
+    "open" : true
+  }, {
+    "type" : "SWITCH",
+    "id" : "id2",
+    "switchId" : "S1VL2_BBS2_COUPLER_DISCONNECTOR",
+    "open" : true
+  }]
+}

java/pypowsybl/src/test/resources/OperatorStrategyFileTestV1.0.json

@@ -0,0 +1,15 @@
+{
+  "version" : "1.1",
+  "operatorStrategies" : [ {
+    "id" : "id1",
+    "contingencyContextType" : "SPECIFIC",
+    "contingencyId" : "First contingency",
+    "conditionalActions" : [ {
+      "id" : "stage1",
+      "condition" : {
+        "type" : "TRUE_CONDITION"
+      },
+      "actionIds" : [ "id1", "id2" ]
+    } ]
+  }]
+}

pypowsybl/_pypowsybl.pyi

@@ -1,6 +1,5 @@
 from logging import Logger
 from typing import ClassVar, Dict, Iterator, List, Sequence, Optional, Union
-
 from numpy import ndarray
 
 class ArrayStruct:
@@ -807,6 +806,8 @@ def add_ratio_tap_changer_position_action(security_analysis_context: JavaHandle,
 def add_shunt_compensator_position_action(security_analysis_context: JavaHandle, action_id: str, shunt_id: str, section: int) -> None: ...
 def add_terminals_connection_action(security_analysis_context: JavaHandle, action_id: str, element_id: str, side: Side, opening: bool) -> None: ...
 def add_operator_strategy(security_analysis_context: JavaHandle, operator_strategy_id: str, contingency_id: str, action_ids: List[str], condition_type: ConditionType, violation_subject_ids: List[str], violation_types: List[ViolationType]) -> None: ...
+def add_action_from_json_file(security_analysis_context: JavaHandle, path_to_json_file: str) -> None: ...
+def add_operator_strategy_from_json_file(security_analysis_context: JavaHandle, path_to_json_file: str) -> None: ...
 def clone_variant(network: JavaHandle, src: str, variant: str, may_overwrite: bool) -> None: ...
 def create_dataframe(columns_values: list, columns_names: List[str], columns_types: List[int], is_index: List[bool]) -> Dataframe: ...
 def create_element(network: JavaHandle, dataframes: List[Optional[Dataframe]], element_type: ElementType) -> None: ...

pypowsybl/security/impl/security.py

@@ -258,3 +258,23 @@ def add_operator_strategy(self, operator_strategy_id: str, contingency_id: str,
         if violation_subject_ids is None:
             violation_subject_ids = []
         _pypowsybl.add_operator_strategy(self._handle, operator_strategy_id, contingency_id, action_ids, condition_type, violation_subject_ids, violation_types)
+
+    def add_actions_from_json_file(self, path_to_json_file: str) -> None:
+        """
+        Add any kinds of actions by reading them from a JSON file.
+
+        Args:
+            path_to_json_file: the path to the JSON file in which we extract the actions' data.
+        """
+
+        _pypowsybl.add_action_from_json_file(self._handle, path_to_json_file)
+
+    def add_operator_strategies_from_json_file(self, path_to_json_file: str) -> None:
+        """
+        Add operator strategies by reading them from a JSON file.
+
+        Args:
+            path_to_json_file: the path to the JSON file in which we extract the operator strategies' data.
+        """
+
+        _pypowsybl.add_operator_strategy_from_json_file(self._handle, path_to_json_file)

tests/test_security_analysis.py

@@ -420,6 +420,15 @@ def test_add_contingencies_from_json_file():
     assert 'contingency' in sa_result.post_contingency_results.keys()
     assert 'contingency2' in sa_result.post_contingency_results.keys()
 
+def test_add_operator_strategies_and_actions_from_json_file():
+    n = pp.network.create_four_substations_node_breaker_network()
+    sa = pp.security.create_analysis()
+    sa.add_single_element_contingency('LINE_S2S3', 'contingency')
+    sa.add_actions_from_json_file(str(DATA_DIR.joinpath('ActionFileTestV1.0.json')))
+    sa.add_operator_strategies_from_json_file(str(DATA_DIR.joinpath('OperatorStrategyFileTestV1.0.json')))
+    sa_result = sa.run_dc(n)
+    assert 'id1' in sa_result.operator_strategy_results.keys()
+
 def test_terminal_connection_action():
     n = pp.network.create_eurostag_tutorial_example1_network()
     sa = pp.security.create_analysis()