-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]> Co-authored-by: Florian Dupuy <[email protected]> Co-authored-by: Sophie Frasnedo <[email protected]> (cherry picked from commit 6357a5b)
- Loading branch information
Showing
8 changed files
with
46 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |