Skip to content

Commit

Permalink
Update dynamic simulation documentation (#3219)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
Co-authored-by: Florian Dupuy <[email protected]>
Co-authored-by: Sophie Frasnedo <[email protected]>
(cherry picked from commit 6357a5b)
  • Loading branch information
Lisrte authored and olperr1 committed Dec 11, 2024
1 parent 91b7b42 commit dd65fac
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/simulation/dynamic/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 8 additions & 7 deletions docs/simulation/dynamic/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
- [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
2 changes: 1 addition & 1 deletion docs/simulation/dynamic_security/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/simulation/dynamic_security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 3 additions & 0 deletions docs/user/itools/dynamic-security-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions docs/user/itools/dynamic-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
3 changes: 2 additions & 1 deletion docs/user/itools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
28 changes: 28 additions & 0 deletions docs/user/itools/list-dynamic-simulation-models.md
Original file line number Diff line number Diff line change
@@ -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 <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.

0 comments on commit dd65fac

Please sign in to comment.