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.

Sign up for GitHub

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

Jump to bottom

Flow decomposition observers #132

Merged
merged 10 commits into from
Jan 31, 2024
Merged

Flow decomposition observers #132

merged 10 commits into from
Jan 31, 2024

Conversation

gverger
Copy link
Member

@gverger gverger commented Jan 12, 2024 •
edited by jeandemanged
Loading

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?
This PR adds an Observer to the flow decomposition computation.
It is possible to attach an observer to be notified of computed matrices during the computation.
This helps building reports to understand the final results of such a computation.

What is the current behavior?
The flow decomposition is opaque.

What is the new behavior (if this is a feature change)?
The intermediate results of the algorithm are sent to the observers.

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

  • Yes
  • No

Other information:
I made sure having no observer (the default production behavior) would not be crippled by this new feature, especially because we need to transform the sparse matrices (internal model) to Maps. The current implementation would not convert these matrices in case there is no observer.

@gverger gverger changed the title Flow decomposition reports WIP: Flow decomposition reports Jan 12, 2024
@gverger gverger force-pushed the feature/flow-decomposition-reports branch 3 times, most recently from 41d92df to c148d9a Compare January 15, 2024 14:56
@gverger gverger changed the title WIP: Flow decomposition reports Flow decomposition reports Jan 15, 2024
@gverger gverger requested a review from phiedw January 18, 2024 15:28
@gverger
Copy link
Member Author

gverger commented Jan 18, 2024

Hello @phiedw , Anne told me that you were probably the right person to ask a review from.
On this particular topic we discussed 4 months ago with Sebastien Murgey.

OpenSuze
OpenSuze reviewed Jan 22, 2024
View reviewed changes
Copy link
Contributor

@OpenSuze OpenSuze left a comment

Choose a reason for hiding this comment

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

Thank you for this PR !
Could you add some documentation please ? A few lines might be enough to give the general idea of your contribution in the powsybl.github.io repository. The main "flow decomposition" document page is here.

flow-decomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionObserver.java Show resolved Hide resolved
flow-decomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionObserver.java Show resolved Hide resolved
...ecomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionObserverList.java Show resolved Hide resolved
...ecomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionObserverList.java Show resolved Hide resolved
...ecomposition/src/test/java/com/powsybl/flow_decomposition/FlowDecompositionObserverTest.java Show resolved Hide resolved
...ecomposition/src/test/java/com/powsybl/flow_decomposition/FlowDecompositionObserverTest.java Show resolved Hide resolved
...ecomposition/src/test/java/com/powsybl/flow_decomposition/FlowDecompositionObserverTest.java Outdated Show resolved Hide resolved
flow-decomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionComputer.java Show resolved Hide resolved
@gverger
Add Flow Decomposition Observers
005b58d 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
Add start and stop to controllers
b15e2f0 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
Add loadflow results to report
1f615cd 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
Add info about fallback activation in AC reports
f8de05c 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
Add all flows to reports
c6be2ec 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
add javadoc to observer interface
7f3d057 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger
flow decomposition observer tests
cede55e 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger gverger force-pushed the feature/flow-decomposition-reports branch from 6a53cae to 8c77df2 Compare January 31, 2024 09:25
@gverger
Respond to feedback: License, authors and test
6e6b05a 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger gverger force-pushed the feature/flow-decomposition-reports branch from 8c77df2 to 6e6b05a Compare January 31, 2024 09:31
@gverger gverger changed the title Flow decomposition reports Flow decomposition obeservers Jan 31, 2024
@gverger gverger changed the title Flow decomposition obeservers Flow decomposition observers Jan 31, 2024
@gverger @jeandemanged
javadoc fixes
644475a 
Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
@jeandemanged
Copy link
Member

Thank you for this PR ! Could you add some documentation please ? A few lines might be enough to give the general idea of your contribution in the powsybl.github.io repository. The main "flow decomposition" document page is here.

Done, Please see powsybl/powsybl.github.io@49290bc

@jeandemanged jeandemanged self-requested a review January 31, 2024 09:52
jeandemanged
jeandemanged approved these changes Jan 31, 2024
View reviewed changes
Copy link
Member

@jeandemanged jeandemanged left a comment

Choose a reason for hiding this comment

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

ty

@OpenSuze
Copy link
Contributor

Thank you for this PR ! Could you add some documentation please ? A few lines might be enough to give the general idea of your contribution in the powsybl.github.io repository. The main "flow decomposition" document page is here.

Done, Please see powsybl/powsybl.github.io@49290bc

Thank you for this documentation !

OpenSuze
OpenSuze reviewed Jan 31, 2024
View reviewed changes
Copy link
Contributor

@OpenSuze OpenSuze left a comment

Choose a reason for hiding this comment

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

Thank you for these corrections !

flow-decomposition/src/main/java/com/powsybl/flow_decomposition/FlowDecompositionComputer.java Show resolved Hide resolved
@gverger
refactor flow extraction
3a79e87 
Signed-off-by: Guillaume Verger <guillaume.verger@artelys.com>
@gverger gverger force-pushed the feature/flow-decomposition-reports branch from fc66424 to 3a79e87 Compare January 31, 2024 11:16
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

2 New issues
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@annetill annetill merged commit 63e62d7 into main Jan 31, 2024
6 checks passed
@annetill annetill deleted the feature/flow-decomposition-reports branch January 31, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OpenSuze OpenSuze OpenSuze approved these changes

@jeandemanged jeandemanged jeandemanged approved these changes

@phiedw phiedw Awaiting requested review from phiedw

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gverger @jeandemanged @OpenSuze @annetill