Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dynamic simulation mappings renaming #3328

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Dynamic simulation mappings renaming #3328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/simulation/dynamic/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/simulation/dynamic_security/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/user/itools/dynamic-security-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/user/itools/dynamic-simulation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down