From a4cd80f15f59ebcddc728293f1fe030945e6123c Mon Sep 17 00:00:00 2001
From: lisrte <laurent.issertial@rte-france.com>
Date: Mon, 1 Jul 2024 14:32:54 +0200
Subject: [PATCH] Update readthedocs

Signed-off-by: lisrte <laurent.issertial@rte-france.com>
---
 .../configuration.md                          | 30 +++++++++++++++++++
 docs/dynamic_security_analysis/index.md       | 18 +++++++++++
 ...nawo-configuration.md => configuration.md} |  0
 docs/dynamic_simulation/index.md              |  2 +-
 docs/index.md                                 | 10 ++++---
 ...flow-configuration.md => configuration.md} |  0
 docs/load_flow/index.md                       |  2 +-
 7 files changed, 56 insertions(+), 6 deletions(-)
 create mode 100644 docs/dynamic_security_analysis/configuration.md
 create mode 100644 docs/dynamic_security_analysis/index.md
 rename docs/dynamic_simulation/{dynawo-configuration.md => configuration.md} (100%)
 rename docs/load_flow/{dynaflow-configuration.md => configuration.md} (100%)

diff --git a/docs/dynamic_security_analysis/configuration.md b/docs/dynamic_security_analysis/configuration.md
new file mode 100644
index 000000000..36a1b937e
--- /dev/null
+++ b/docs/dynamic_security_analysis/configuration.md
@@ -0,0 +1,30 @@
+# Configuration
+
+## Dynawo-algorithms properties
+The `dynawo-algorithms` module defines the required parameters to run with Dynawo.
+
+**homeDir**  
+Use the `homeDir` property to defines the installation directory of the dynawo simulator.
+
+**debug**  
+Use the `debug` property to specify if the temporary folder where the inputs are generated should be kept after the simulation.
+
+### Examples
+
+**YAML configuration:**
+```yaml
+dynawo-algorithms:
+  homeDir: /home/user/dynawo-algorithms
+  debug: false
+```
+
+**XML configuration:**
+```xml
+<dynawo-algorithms>
+  <homeDir>/home/user/dynawo</homeDir>
+  <debug>false</debug>
+</dynawo-algorithms>
+```
+
+## Default parameters
+The dynamic security analysis reuse the `dynawo-default-parameters` [module](../dynamic_simulation/configuration.md#default-parameters).
diff --git a/docs/dynamic_security_analysis/index.md b/docs/dynamic_security_analysis/index.md
new file mode 100644
index 000000000..3db8e4e84
--- /dev/null
+++ b/docs/dynamic_security_analysis/index.md
@@ -0,0 +1,18 @@
+# Dynamic security analysis
+
+```{toctree}
+:hidden:
+configuration.md
+```
+
+PowSyBl provides an implementation of the [DynamicSecurityAnalysis API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic_security/index) with [Dynaωo-algorithms](https://dynawo.github.io/about/dynalgo), a wrapper around [Dynaωo](https://dynawo.github.io) providing utility algorithms to calculate complex key values of a power system.
+
+## Installation
+
+Read this [documentation page](https://dynawo.github.io/install/dynalgo) to learn how to install and configure Dynaωo-algorithms.
+
+## Going further
+
+You may find an extensive documentation of the Dynawo project [here](https://github.com/dynawo/dynawo/releases/latest/download/DynawoDocumentation.pdf).  
+The dynamic security analysis use the same dynamic models supplier as the dynamic simulation implementation, documentation can be found [here](../dynamic_simulation/dynamic-models-dsl.md).
+
diff --git a/docs/dynamic_simulation/dynawo-configuration.md b/docs/dynamic_simulation/configuration.md
similarity index 100%
rename from docs/dynamic_simulation/dynawo-configuration.md
rename to docs/dynamic_simulation/configuration.md
diff --git a/docs/dynamic_simulation/index.md b/docs/dynamic_simulation/index.md
index 67bc6ac78..b96ba4a78 100644
--- a/docs/dynamic_simulation/index.md
+++ b/docs/dynamic_simulation/index.md
@@ -2,7 +2,7 @@
 
 ```{toctree}
 :hidden:
-dynawo-configuration.md
+configuration.md
 dynamic-models-dsl.md
 event-models-dsl.md
 curves-dsl.md
diff --git a/docs/index.md b/docs/index.md
index bdf6e07cb..a5525d149 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,11 +1,13 @@
 # Powsybl-dynawo documentation
-Powsybl-dynawo is an interface between PowSyBl and [Dynaωo](https://dynawo.github.io) open source suites, providing:
-- an implementation of [LoadFlow API from powsybl-core](inv:powsyblcore:*:*#simulation/loadflow/index),
-- an implementation of [SecurityAnalysis API from powsybl-core](inv:powsyblcore:*:*#simulation/security/index),
-- an implementation of [DynamicSimulation API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic/index).
+Powsybl-dynawo is an interface between PowSyBl and [Dynaωo](https://dynawo.github.io) open source suites, providing implementations of:
+- [LoadFlow API from powsybl-core](inv:powsyblcore:*:*#simulation/loadflow/index),
+- [SecurityAnalysis API from powsybl-core](inv:powsyblcore:*:*#simulation/security/index),
+- [DynamicSimulation API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic/index),
+- [DynamicSecurityAnalysis API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic_security/index).
 
 ```{toctree}
 :hidden:
 load_flow/index.md
 dynamic_simulation/index.md
+dynamic_security_analysis/index.md
 ```
diff --git a/docs/load_flow/dynaflow-configuration.md b/docs/load_flow/configuration.md
similarity index 100%
rename from docs/load_flow/dynaflow-configuration.md
rename to docs/load_flow/configuration.md
diff --git a/docs/load_flow/index.md b/docs/load_flow/index.md
index 21df76d21..d949adfef 100644
--- a/docs/load_flow/index.md
+++ b/docs/load_flow/index.md
@@ -2,7 +2,7 @@
 
 ```{toctree}
 :hidden:
-dynaflow-configuration.md
+configuration.md
 ```
 
 PowSyBl provides an implementation of the [LoadFlow API from powsybl-core](inv:powsyblcore:*:*#simulation/loadflow/index) with [DynaFlow](https://dynawo.github.io/about/dynaflow).