From 7dd2156d2326cb915fa73f260a77a6b73370cbd2 Mon Sep 17 00:00:00 2001 From: lisrte Date: Wed, 19 Feb 2025 17:10:43 +0100 Subject: [PATCH] Rename dynamic event and output variable 'mapping' to configuration Signed-off-by: lisrte --- docs/simulation/dynamic/index.md | 15 +++++++-------- docs/simulation/dynamic_security/index.md | 6 +++--- docs/user/itools/dynamic-security-analysis.md | 2 +- docs/user/itools/dynamic-simulation.md | 6 +++--- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/simulation/dynamic/index.md b/docs/simulation/dynamic/index.md index 6dbc1ba5cc9..1a807e5e6bd 100644 --- a/docs/simulation/dynamic/index.md +++ b/docs/simulation/dynamic/index.md @@ -17,25 +17,24 @@ The inputs of a dynamic simulation are the following: - a static network - a set of dynamic models provided by the simulator - a set of parameters associated to each dynamic model, with carefully chosen values -- a mapping between static components of the network and dynamic models - optionally, a description of events occurring in the dynamic simulation (disconnection of a line, change of tap for a transformer, etc.) - a set of parameters for the simulator itself (simulation start and stop time, solver parameters, etc.) - a configuration file to configure the output variables to export at the end of the simulation -(dynamic-models-mapping)= -### Dynamic models mapping +(dynamic-models-configuration)= +### Dynamic models configuration 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. +See [Dynawo dynamic model configuration](inv:powsybldynawo:*:*#dynamic_simulation/dynamic-models-configuration) for Dynawo specific DSL and others configuration methods. -(event-models-mapping)= -### Event models mapping +(event-models-configuration)= +### Event models configuration 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. +See [Dynawo event model configuration](inv:powsybldynawo:*:*#dynamic_simulation/event-models-configuration) for Dynawo specific DSL and others configuration methods. (output-variables-configuration)= ### Output variables configuration 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. +See [Dynawo output variables configuration](inv:powsybldynawo:*:*#dynamic_simulation/output-variables-configuration) for Dynawo specific DSL and others configuration methods. ## Outputs diff --git a/docs/simulation/dynamic_security/index.md b/docs/simulation/dynamic_security/index.md index 22221043c05..6a3b73ae39d 100644 --- a/docs/simulation/dynamic_security/index.md +++ b/docs/simulation/dynamic_security/index.md @@ -9,11 +9,11 @@ The dynamic security analysis is a [security analysis](../security/index.md) usi ## Inputs -### Dynamic models mapping -The dynamic models mapping is exactly the same [mapping](../dynamic/index.md#dynamic-models-mapping) used for a dynamic simulation. +### Dynamic models configuration +The dynamic models configuration is exactly the same [configuration](../dynamic/index.md#dynamic-models-configuration) used for a dynamic simulation. ### Other inputs -Besides dynamic models mapping, the dynamic security analysis requires the same [inputs as the standard one](../security/index.md#inputs). +Besides dynamic models configuration, the dynamic security analysis requires the same [inputs as the standard one](../security/index.md#inputs). ## Outputs The dynamic security analysis produces the same outputs as the standard one. All outputs can be found [here](../security/index.md#outputs). diff --git a/docs/user/itools/dynamic-security-analysis.md b/docs/user/itools/dynamic-security-analysis.md index cc0e8d5ac0f..fdf051f8e28 100644 --- a/docs/user/itools/dynamic-security-analysis.md +++ b/docs/user/itools/dynamic-security-analysis.md @@ -49,7 +49,7 @@ Allowed EXTENSIONS values are [] This option defines the path of the case file on which the security analysis is run. The [supported formats](../../grid_exchange_formats/index.md) depend on the execution class path. `--dynamic-models-file` -This option defines the path of the mapping file used to associate dynamic models to static equipments of the network or add dynamic automation systems. At the moment, only groovy scripts are supported. The [dynamic models DSL](../../simulation/dynamic/index.md#dynamic-models-mapping) depends on the simulator used. +This option defines the path of the file used to associate dynamic models to static equipments of the network or add dynamic automation systems. At the moment, only groovy scripts are supported. The [dynamic models DSL](../../simulation/dynamic/index.md#dynamic-models-mapping) depends on the simulator used. ### Optional arguments diff --git a/docs/user/itools/dynamic-simulation.md b/docs/user/itools/dynamic-simulation.md index a2f16355641..7f037b7aac9 100644 --- a/docs/user/itools/dynamic-simulation.md +++ b/docs/user/itools/dynamic-simulation.md @@ -44,15 +44,15 @@ Available arguments are: This option defines the path of the case file on which the simulation is run. The [supported formats](../../grid_exchange_formats/index.md) depend on the execution class path. `--dynamic-models-file` -This option defines the path of the mapping file used to associate dynamic models to static equipments of the network or add dynamic automation systems. At the moment, only groovy scripts are supported. The [dynamic models DSL](../../simulation/dynamic/index.md#dynamic-models-mapping) depends on the simulator used. +This option defines the path of the file used to associate dynamic models to static equipments of the network or add dynamic automation systems. At the moment, only groovy scripts are supported. The [dynamic models DSL](../../simulation/dynamic/index.md#dynamic-models-configuration) depends on the simulator used. ### Optional options `--output-variables-file` -This option defines the path of the configuration for the output variables to export at the end of the simulation. This configuration file is a groovy script that respects the [outputVariables DSL](../../simulation/dynamic/index.md#output-variables-configuration) syntax. +This option defines the path of the configuration for the output variables to export at the end of the simulation. This configuration file is a groovy script that respects the [output variables DSL](../../simulation/dynamic/index.md#output-variables-configuration) syntax. `--event-models-file` -This option defines the path of the configuration for the events to simulate during the simulation. At the moment, only groovy scripts are supported. The [event models DSL](../../simulation/dynamic/index.md#event-models-mapping) depends on the simulator used. +This option defines the path of the configuration for the events to simulate during the simulation. At the moment, only groovy scripts are supported. The [event models DSL](../../simulation/dynamic/index.md#event-models-configuration) depends on the simulator used. `--import-parameters` This option defines the path of the importer's configuration file. It's possible to overload one or many parameters using the `-I property=value` syntax. The list of supported properties depends on the [input format](../../grid_exchange_formats/index.md).