Documentation update

Signed-off-by: lisrte <laurent.issertial@rte-france.com>
powsybl · Dec 12, 2024 · 468d08c · 468d08c
1 parent e682730
commit 468d08c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 11 deletions.
diff --git a/docs/reference/dynamic.rst b/docs/reference/dynamic.rst
@@ -47,16 +47,16 @@ EventMapping
     EventMapping.add_active_power_variation
     EventMapping.add_node_fault
 
-CurveMapping
+OutputVariableMapping
 ------------
 .. autosummary::
     :toctree: api/
 
-    CurveMapping
-    CurveMapping.add_dynamic_model_curves
-    CurveMapping.add_standard_model_curves
-    CurveMapping.add_dynamic_model_final_state_values
-    CurveMapping.add_standard_model_final_state_values
+    OutputVariableMapping
+    OutputVariableMapping.add_dynamic_model_curves
+    OutputVariableMapping.add_standard_model_curves
+    OutputVariableMapping.add_dynamic_model_final_state_values
+    OutputVariableMapping.add_standard_model_final_state_values
 
 Simulation
 ----------
@@ -74,3 +74,4 @@ Results
     SimulationResult
     SimulationResult.status
     SimulationResult.curves
+    SimulationResult.final_state_values
diff --git a/docs/user_guide/dynamic.rst b/docs/user_guide/dynamic.rst
@@ -46,7 +46,7 @@ To make a dynamic simulation, you need multiple things:
 
     1. A dynamic mapping, it links the static elements (generators, loads, lines) to their dynamic behavior (alpha beta load)
     2. A event mapping, it maps the different events. (e.g equipment disconnection)
-    3. A curve mapping, it records the given values to be watch by the simulation tool. Curves are the output of the simulation
+    3. A output variable mapping, it records the given values to be watch by the simulation tool (can be curves or final state values).
 
 There is a class for each of these elements.
 
@@ -83,7 +83,7 @@ To run a Dynawo simulation:
     # curves mapping
     variables_mapping = dyn.OutputVariableMapping()
     variables_mapping.add_dynamic_model_curves("DM_LOAD", ["load_PPu", "load_QPu"])
-    variables_mapping.add_standard_model_final_state_values('NGEN', 'Upu_value', False) # and so on
+    variables_mapping.add_standard_model_final_state_values('NGEN', 'Upu_value') # and so on
 
     # simulations parameters
     start_time = 0
@@ -93,4 +93,5 @@ To run a Dynawo simulation:
     results = sim.run(network, model_mapping, event_mapping, variables_mapping, start_time, end_time)
     # getting the results
     results.status()
-    results.curves() # dataframe containing the mapped curves
+    results.curves() # dataframe containing the mapped curves
+    results.final_state_values() # dataframe containing the mapped final state values
diff --git a/java/src/main/java/com/powsybl/python/dynamic/DynamicSimulationContext.java b/java/src/main/java/com/powsybl/python/dynamic/DynamicSimulationContext.java
@@ -22,13 +22,13 @@ public class DynamicSimulationContext {
     public DynamicSimulationResult run(Network network,
                                        DynamicModelsSupplier dynamicModelsSupplier,
                                        EventModelsSupplier eventModelsSupplier,
-                                       OutputVariablesSupplier curvesSupplier,
+                                       OutputVariablesSupplier outputVariablesSupplier,
                                        DynamicSimulationParameters parameters,
                                        ReportNode reportNode) {
         return DynamicSimulation.find(DEFAULT_PROVIDER).run(network,
                 dynamicModelsSupplier,
                 eventModelsSupplier,
-                curvesSupplier,
+                outputVariablesSupplier,
                 network.getVariantManager().getWorkingVariantId(),
                 LocalComputationManager.getDefault(),
                 parameters,