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.

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

Update time domain documentation #3219

Merged
merged 4 commits into from
Dec 11, 2024
Merged

Conversation

Lisrte
Copy link
Contributor

@Lisrte Lisrte commented Nov 20, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Docs update

What is the current behavior?

What is the new behavior (if this is a feature change)?
Replace Dynawaltz provider name with Dynawo
Update link to powsybl-dynawo and reference to DSL/ mapping (PR 410)
Add documentation for itools command list-dynamic-simulation-models

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

Other information:

Linked to PR 410

Update link to powsybl-dynawo and reference to DLS/ mapping.
Add documentation for itools command list-dynamic-simulation-models

Signed-off-by: lisrte <[email protected]>
@Lisrte Lisrte requested a review from flo-dup November 20, 2024 16:24
@Lisrte Lisrte self-assigned this Nov 20, 2024
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/user/itools/list-dynamic-simulation-models.md Outdated Show resolved Hide resolved
docs/user/itools/list-dynamic-simulation-models.md Outdated Show resolved Hide resolved
Copy link
Member

@So-Fras So-Fras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for improving the documentation. I left some minor remarks about typos.

docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/simulation/dynamic/index.md Outdated Show resolved Hide resolved
docs/user/itools/dynamic-security-analysis.md Outdated Show resolved Hide resolved
docs/user/itools/dynamic-simulation.md Outdated Show resolved Hide resolved
docs/user/itools/list-dynamic-simulation-models.md Outdated Show resolved Hide resolved
docs/user/itools/list-dynamic-simulation-models.md Outdated Show resolved Hide resolved
docs/user/itools/list-dynamic-simulation-models.md Outdated Show resolved Hide resolved
Lisrte and others added 2 commits December 4, 2024 16:34
Signed-off-by: lisrte <[email protected]>
Co-authored-by: Sophie Frasnedo <[email protected]>
Signed-off-by: Florian Dupuy <[email protected]>
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in the PR powsybl/powsybl-dynawo#410, could we speak of mapping for events? and for output variables?

Copy link
Member

@So-Fras So-Fras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the work!

Copy link

sonarcloud bot commented Dec 11, 2024

@olperr1 olperr1 dismissed flo-dup’s stale review December 11, 2024 07:51

Seen with @flo-du: OK to merge this PR in this state to have it in the 6.6.0 release. It fixes the documentation and the last comment is not crucial.

@olperr1 olperr1 merged commit 6357a5b into main Dec 11, 2024
8 checks passed
@olperr1 olperr1 deleted the time_domain_documentation_update branch December 11, 2024 07:58
olperr1 pushed a commit that referenced this pull request Dec 11, 2024
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants