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

RaoResult writer API #1136

Closed
pet-mit opened this issue Sep 16, 2024 · 0 comments · Fixed by #1158
Closed

RaoResult writer API #1136

pet-mit opened this issue Sep 16, 2024 · 0 comments · Fixed by #1158
Labels
breaking-change Changes could break users' code cleaning This issue or pull request only concerns improving the overall state of the code feature New feature or request

Comments

@pet-mit
Copy link
Collaborator

pet-mit commented Sep 16, 2024

Describe the current behavior

RaoResult can be exported to json, core cne, or swe cne. Three APIs exist for those purposes.

Describe the expected behavior

Unify the API by creating one method : raoResult.write

Describe the motivation

cleaner API, ease to add new exporters, ease to develop python api

Extra Information

  • The method has the following arguments : CracCreationContext, Properties (that contains all specific information needed for specific exporters)
  • The CNE exporters shall no longer need the Network : some preparatory work might be needed (for instance, adding information to the CracCreationContext)
  • If it's useful, we can add a second method that uses a Crac instead of CracCreationContext
  • If it's a lot of work, try to split it up in multiple Pull Requests
@pet-mit pet-mit added feature New feature or request cleaning This issue or pull request only concerns improving the overall state of the code breaking-change Changes could break users' code labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Changes could break users' code cleaning This issue or pull request only concerns improving the overall state of the code feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant