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

Models documentation #367

Merged
merged 14 commits into from
Jul 17, 2024
Merged

Models documentation #367

merged 14 commits into from
Jul 17, 2024

Conversation

Lisrte
Copy link
Contributor

@Lisrte Lisrte commented Jun 25, 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?

Feature

What is the current behavior?

What is the new behavior (if this is a feature change)?
Add model documentation 'doc' field in JSON
Documentation is accessible from models builder and itools
Rename lib (or tag event model) to modelName when lib or alias is used :

  • lib now refers exclusively to the library name used by Dynawo
  • modelName/name is the name used in powsybl-dynawo in builders and suppliers and DSL i.e. an alias if it exists or the lib value

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

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

Replace every builders getSupportedLibs with getSupportedModelInfos:

  • getSupportedModelInfos returns a collection of ModelInfo
  • the name of the supported libs (model name) is returned by ModelInfo::name
    Replace BuilderConfig getLibs with getModelInfos.

Replace every event builders getTag with getModelName and add a static getEventModelInfo
Replace EventBuilderConfig getTag with getEventModelInfo.

Lisrte added 3 commits June 19, 2024 10:04
Return formatted doc in DynamicModelGroovyExtension::getModelNames

Signed-off-by: lisrte <[email protected]>
@Lisrte Lisrte added the Breaking Change API is broken label Jul 3, 2024
Lisrte added 5 commits July 4, 2024 15:24
Add ModelInfo interface

Signed-off-by: lisrte <[email protected]>
# Conflicts:
#	dynawaltz/src/main/java/com/powsybl/dynawaltz/builders/ModelConfigLoaderImpl.java
Signed-off-by: lisrte <[email protected]>
@Lisrte Lisrte requested a review from flo-dup July 5, 2024 08:30
@Lisrte Lisrte marked this pull request as draft July 5, 2024 08:40
Add EventModelInfo

Signed-off-by: lisrte <[email protected]>
@Lisrte Lisrte marked this pull request as ready for review July 5, 2024 10:50
Signed-off-by: lisrte <[email protected]>
ModelConfigs::getModelsName returns unmodifiableSet

Signed-off-by: lisrte <[email protected]>
@flo-dup flo-dup enabled auto-merge (squash) July 17, 2024 13:08
Copy link

@flo-dup flo-dup merged commit b510b19 into main Jul 17, 2024
7 checks passed
@flo-dup flo-dup deleted the models_documentation branch July 17, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants