Skip to content

Commit

Permalink
Add missing documentation (#410)
Browse files Browse the repository at this point in the history
* Add the different models suppliers definition.
* Add missing event and dynamic model description.
* Update of Dynaflow parameters documentation based on DynaFlowLauncherDocumentation
* Reorder parameter documentation
* Fix Tap changer doc
* Update disconnect event documentation

Signed-off-by: lisrte <[email protected]>
  • Loading branch information
Lisrte authored Dec 13, 2024
1 parent 44bf8b8 commit e226a1d
Show file tree
Hide file tree
Showing 11 changed files with 713 additions and 172 deletions.
2 changes: 1 addition & 1 deletion docs/dynamic_security_analysis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Read this [documentation page](https://dynawo.github.io/install/dynalgo) to lear
## Going further

You may find an extensive documentation of the Dynawo project [here](https://github.com/dynawo/dynawo/releases/latest/download/DynawoDocumentation.pdf).
The dynamic security analysis use the same dynamic models supplier as the dynamic simulation implementation, documentation can be found [here](../dynamic_simulation/dynamic-models-dsl.md).
The dynamic security analysis uses the same dynamic models supplier as the dynamic simulation implementation, documentation can be found [here](../dynamic_simulation/dynamic-models-mapping).

5 changes: 3 additions & 2 deletions docs/dynamic_simulation/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,23 +100,24 @@ The default value is `1e-6`.

**log.levelFilter**
`log.levelFilter` defines the log level for Dynawo log.
The default value is `INFO`.
The available `com.powsybl.dynawo.DynawoSimulationParameters.LogLevel` values are:
- `DEBUG`
- `INFO`
- `WARN`
- `ERROR`

The default value is `INFO`.

**log.specificLogs**
`log.specificLogs` defines as a list the specifics logs to return besides the regular Dynawo log.
The default value is an empty list.
The available `com.powsybl.dynawo.DynawoSimulationParameters.SpecificLog` values are:
- `NETWORK`
- `MODELER`
- `PARAMETERS`
- `VARIABLES`
- `EQUATIONS`

The default value is an empty list.

**criteria.file**
`criteria.file` defines the simulation criteria file.
Expand Down
101 changes: 0 additions & 101 deletions docs/dynamic_simulation/dynamic-models-dsl.md

This file was deleted.

Loading

0 comments on commit e226a1d

Please sign in to comment.