Add documentation to list the currently implemented security analysis… (

#1166) Signed-off-by: CARON Alice <[email protected]>
powsybl · Jan 13, 2025 · 8dfdd49 · 8dfdd49
1 parent 0248094
commit 8dfdd49
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/security/index.md b/docs/security/index.md
@@ -7,4 +7,5 @@ hidden: true
 ---
 security.md
 parameters.md
+inputs.md
 ```
diff --git a/docs/security/inputs.md b/docs/security/inputs.md
@@ -0,0 +1,18 @@
+# Inputs
+
+To run a PowSyBl Open Load Flow security analysis, you have to precise some inputs that are documented in [PowSyBl Core](inv:powsyblcore:*:*#simulation/security/index).
+
+## Implemented remedial actions
+
+With Open Load Flow only the following remedial actions are currently implemented:
+
+- `LoadAction`
+- `SwitchAction`
+- `TerminalsConnectionAction`
+- `PhaseTapChangerTapPositionAction`
+- `RatioTapChangerTapPositionAction`
+- `ShuntCompensatorPositionAction`
+- `GeneratorAction`
+- `HvdcAction`
+
+Note: Some limitations in the use of these actions exist, please read the documentation about the [security analysis specific parameters](parameters).