From 6357a5be9dcfb8f1a40d8bcc48a9c21ecf59694a Mon Sep 17 00:00:00 2001 From: Lisrte Date: Wed, 11 Dec 2024 08:58:12 +0100 Subject: [PATCH] Update dynamic simulation documentation (#3219) * Replace Dynawaltz with Dynawo Update link to powsybl-dynawo and reference to DLS/ mapping. Add documentation for itools command list-dynamic-simulation-models * Apply suggestions from code review Signed-off-by: lisrte Co-authored-by: Florian Dupuy <66690739+flo-dup@users.noreply.github.com> Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com> --- docs/simulation/dynamic/configuration.md | 2 +- docs/simulation/dynamic/index.md | 15 +++++----- .../dynamic_security/configuration.md | 2 +- docs/simulation/dynamic_security/index.md | 1 + docs/user/itools/dynamic-security-analysis.md | 3 ++ docs/user/itools/dynamic-simulation.md | 4 +-- docs/user/itools/index.md | 3 +- .../itools/list-dynamic-simulation-models.md | 28 +++++++++++++++++++ 8 files changed, 46 insertions(+), 12 deletions(-) create mode 100644 docs/user/itools/list-dynamic-simulation-models.md diff --git a/docs/simulation/dynamic/configuration.md b/docs/simulation/dynamic/configuration.md index c696f4be8eb..65673895861 100644 --- a/docs/simulation/dynamic/configuration.md +++ b/docs/simulation/dynamic/configuration.md @@ -3,7 +3,7 @@ ## Implementation If you have several implementations in your classpath, you need to choose which implementation to use in your configuration file with the `default-impl-name` property. Each implementation is identified by its name, that may be unique in the classpath: -- use "DynaWaltz" to use powsybl-dynawo implementation +- Use "Dynawo" to use powsybl-dynawo implementation **YAML configuration:** ```yaml diff --git a/docs/simulation/dynamic/index.md b/docs/simulation/dynamic/index.md index c3c6b963ad8..6dbc1ba5cc9 100644 --- a/docs/simulation/dynamic/index.md +++ b/docs/simulation/dynamic/index.md @@ -24,18 +24,18 @@ The inputs of a dynamic simulation are the following: (dynamic-models-mapping)= ### Dynamic models mapping -For the moment, the only way to associate dynamic models to static components is through a groovy script. Note that the syntax of this script is specific to each simulator: -- [Dynawo dynamic model DSL](inv:powsybldynawo:*:*#dynamic_simulation/dynamic-models-dsl) +The dynamic models may be provided through a groovy script thanks to the `GroovyDynamicModelsSupplier` provided in powsybl-dynamic-simulation-dsl artifact. Note that the syntax of this groovy script is specific to each simulator. +See [Dynawo dynamic model mapping](inv:powsybldynawo:*:*#dynamic_simulation/dynamic-models-mapping) for Dynawo specific DSL and others mapping methods. (event-models-mapping)= ### Event models mapping -For the moment, the only way to add events to the simulation is through a groovy script. Note that the syntax of this script is specific to each simulator: -- [Dynawo event model DSL](inv:powsybldynawo:*:*#dynamic_simulation/event-models-dsl) +The event models may be provided through a groovy script thanks to the `GroovyEventModelsSupplier` provided in powsybl-dynamic-simulation-dsl artifact. Note that the syntax of this groovy script is specific to each simulator. +See [Dynawo event model DSL](inv:powsybldynawo:*:*#dynamic_simulation/event-models-mapping) for Dynawo specific DSL and others mapping methods. (output-variables-configuration)= ### Output variables configuration -For the moment, the only way to add output variables configuration is to provide a groovy script to the simulation. Note that the syntax of this script is specific to each simulator: -- [Dynawo output variables DSL](inv:powsybldynawo:*:*#dynamic_simulation/output-variables-dsl) +The output variables configuration may be provided through a groovy script thanks to the `GroovyOutputVariablesSupplier` provided in powsybl-dynamic-simulation-dsl artifact. Note that the syntax of this groovy script is specific to each simulator. +See [Dynawo output variables DSL](inv:powsybldynawo:*:*#dynamic_simulation/output-variables-mapping) for Dynawo specific DSL and others mapping methods. ## Outputs @@ -52,4 +52,5 @@ The outputs of a dynamic simulation are: For the moment, the only available implementation is provided by powsybl-dynawo, which links PowSyBl with [Dynaωo](http://dynawo.org) open source suite. ## Going further -- [Run a dynamic simulation through an iTools command](../../user/itools/dynamic-simulation.md): Learn how to perform a dynamic simulation from the command line \ No newline at end of file +- [Run a dynamic simulation through an iTools command](../../user/itools/dynamic-simulation.md): learn how to perform a dynamic simulation from the command line +- [List dynamic simulation models with an iTools command](../../user/itools/list-dynamic-simulation-models.md): learn how to load a list of all dynamic simulation models from the command line diff --git a/docs/simulation/dynamic_security/configuration.md b/docs/simulation/dynamic_security/configuration.md index 63485b1f80a..85945cd352f 100644 --- a/docs/simulation/dynamic_security/configuration.md +++ b/docs/simulation/dynamic_security/configuration.md @@ -3,7 +3,7 @@ ## Implementation If you have several implementations in your classpath, you need to choose which implementation to use in your configuration file with the `default-impl-name` property. Each implementation is identified by its name, that may be unique in the classpath: -- use "DynaWaltz" to use powsybl-dynawo implementation +- Use "Dynawo" to use powsybl-dynawo implementation **YAML configuration:** ```yaml diff --git a/docs/simulation/dynamic_security/index.md b/docs/simulation/dynamic_security/index.md index 3db2a273947..22221043c05 100644 --- a/docs/simulation/dynamic_security/index.md +++ b/docs/simulation/dynamic_security/index.md @@ -25,3 +25,4 @@ For the moment, the only available implementation is provided by powsybl-dynawo, - Security analysis [Action DSL](../security/action-dsl.md). - Security analysis [Contingency DSL](../security/action-dsl.md). - [Run a dynamic security analysis through an iTools command](../../user/itools/dynamic-security-analysis.md): Learn how to perform a security analysis from the command line. +- [List dynamic simulation models with an iTools command](../../user/itools/list-dynamic-simulation-models.md): learn how to load a list of all dynamic simulation models from the command line. \ No newline at end of file diff --git a/docs/user/itools/dynamic-security-analysis.md b/docs/user/itools/dynamic-security-analysis.md index afd22662d73..cc0e8d5ac0f 100644 --- a/docs/user/itools/dynamic-security-analysis.md +++ b/docs/user/itools/dynamic-security-analysis.md @@ -95,3 +95,6 @@ This option defines the list of extensions to complete the simulation results wi ### with-extensions Use the `--with-extensions` parameter to activate a list of `com.powsybl.security.interceptors.SecurityAnalysisInterceptor` implementations. + +## See also +- [List dynamic simulation models with an iTools command](../../user/itools/list-dynamic-simulation-models.md): learn how to load a list of all dynamic simulation models from the command line. diff --git a/docs/user/itools/dynamic-simulation.md b/docs/user/itools/dynamic-simulation.md index a754af94be7..a2f16355641 100644 --- a/docs/user/itools/dynamic-simulation.md +++ b/docs/user/itools/dynamic-simulation.md @@ -64,11 +64,10 @@ This option defines the path where to export the [results](#results) of the simu This option defines the path of the [parameters](#parameters) file of the simulation. If this option is not used, the simulation is run with the default parameters. ## Simulators - The available power flow simulators implementations are described [here](../../simulation/dynamic/index.md#implementations). ## Parameters -The available parameters are described [here](../../simulation/dynamic/parameters.md). +The available parameters are described [here](../../simulation/dynamic/configuration.md). ## Results The expected results are described in the [time domain documentation](../../simulation/dynamic/index.md#outputs) @@ -98,3 +97,4 @@ dynamic simulation results: ``` ## See also +- [List dynamic simulation models with an iTools command](../../user/itools/list-dynamic-simulation-models.md): learn how to load a list of all dynamic simulation models from the command line. diff --git a/docs/user/itools/index.md b/docs/user/itools/index.md index 66bcd08f681..a5aec09dfb4 100644 --- a/docs/user/itools/index.md +++ b/docs/user/itools/index.md @@ -9,12 +9,13 @@ action-simulator.md cim_anonymizer.md compare-security-analysis-results.md convert_network.md +dynamic-security-analysis.md dynamic-simulation.md +list-dynamic-simulation-models.md loadflow.md loadflow-validation.md run-script.md security-analysis.md -dynamic-security-analysis.md sensitivity-computation.md ``` diff --git a/docs/user/itools/list-dynamic-simulation-models.md b/docs/user/itools/list-dynamic-simulation-models.md new file mode 100644 index 00000000000..cc8593b81fa --- /dev/null +++ b/docs/user/itools/list-dynamic-simulation-models.md @@ -0,0 +1,28 @@ +# iTools list-dynamic-simulation-models + +The `list-dynamic-simulation-models` command lists all models used by the [time domain](../../simulation/dynamic/index.md) simulation for a given provider. + +## Usage +``` +usage: itools [OPTIONS] list-dynamic-simulation-models [--dynamic-models] + [--event-models] [--help] + +Available options are: + --config-name Override configuration file name + +Available arguments are: + --dynamic-models display implemented dynamic models + --event-models display implemented event models + --help display the help and quit + +``` + +### Optional options + +By default, all models are displayed, but you can use one of the following options to display specific models: +- `--dynamic-models`: allows to display dynamic models only. + +- `--event-models`: allows to display event models only. + +## See also +- [Run a dynamic simulation through an iTools command](../../user/itools/dynamic-simulation.md): learn how to perform a dynamic simulation from the command line.