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

rao-result-io module and better definition of paths #1200

Merged
merged 6 commits into from
Dec 2, 2024
Merged

rao-result-io module and better definition of paths #1200

merged 6 commits into from
Dec 2, 2024

Conversation

bqth29
Copy link
Collaborator

@bqth29 bqth29 commented Nov 28, 2024 •
edited
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?
Fixes #1183

What kind of change does this PR introduce?
new rao-result module structure and naming

rao-result (com.powsybl.openrao.data.raoresult)
 |_ rao-result-api (com.powsybl.openrao.data.raoresult.api)
 |_ rao-result-impl (com.powsybl.openrao.data.raoresult.impl)
 |_ rao-result-io (com.powsybl.openrao.data.raoresult.io)
     |_ rao-result-cne (com.powsybl.openrao.data.raoresult.io.cne)
         |_ cne-exporter-commons (com.powsybl.openrao.data.raoresult.io.cne.commons)
         |_ core-cne-exporter (com.powsybl.openrao.data.raoresult.io.cne.core)
         |_ swe-cne-exporter (com.powsybl.openrao.data.raoresult.io.cne.swe)
     |_ rao-result-json (com.powsybl.openrao.data.raoresult.io.json)

What is the current behavior?

What is the new behavior (if this is a feature change)?

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)

Other information:

@bqth29
create rao-result-io module
886e5f2 
Signed-off-by: Thomas Bouquet <[email protected]>
@bqth29
path renaming
039dfc0 
Signed-off-by: Thomas Bouquet <[email protected]>
@bqth29
rao-result-cne module
8e1ca29 
Signed-off-by: Thomas Bouquet <[email protected]>
@bqth29
rao result files path
383d124 
Signed-off-by: Thomas Bouquet <[email protected]>
@bqth29 bqth29 added PR: waiting-for-review This PR is waiting to be reviewed cleaning This issue or pull request only concerns improving the overall state of the code breaking-change Changes could break users' code labels Nov 28, 2024
@bqth29
Copy link
Collaborator Author

bqth29 commented Nov 28, 2024

same work to be done for crac module with crac.api, crac.impl and crac.io

Godelaine
Godelaine previously approved these changes Dec 2, 2024
View reviewed changes
bqth29 added 2 commits December 2, 2024 14:46
@bqth29
Merge branch 'main' into cleaning/rao-result-io
de1d383 
# Conflicts:
#	data/rao-result/rao-result-api/src/main/java/com/powsybl/openrao/data/raoresult/api/RaoResult.java
#	data/rao-result/rao-result-api/src/main/java/com/powsybl/openrao/data/raoresult/api/io/Exporter.java
#	data/rao-result/rao-result-api/src/main/java/com/powsybl/openrao/data/raoresult/api/io/Importer.java
#	data/rao-result/rao-result-api/src/test/java/com/powsybl/openrao/data/raoresult/api/MockRaoResultExporter.java
#	data/rao-result/rao-result-api/src/test/java/com/powsybl/openrao/data/raoresult/api/MockRaoResultImporter.java
#	data/rao-result/rao-result-impl/src/main/java/com/powsybl/openrao/data/raoresult/impl/RaoResultImpl.java
#	data/rao-result/rao-result-impl/src/test/java/com/powsybl/openrao/data/raoresult/impl/RaoResultImplTest.java
#	data/rao-result/rao-result-impl/src/test/java/com/powsybl/openrao/data/raoresult/impl/utils/ExhaustiveRaoResultCreation.java
#	data/rao-result/rao-result-io/rao-result-cne/cne-exporter-commons/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/commons/CneHelper.java
#	data/rao-result/rao-result-io/rao-result-cne/cne-exporter-commons/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/commons/CneHelperTest.java
#	data/rao-result/rao-result-io/rao-result-cne/core-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/core/CoreCne.java
#	data/rao-result/rao-result-io/rao-result-cne/core-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/core/CoreCneExporter.java
#	data/rao-result/rao-result-io/rao-result-cne/core-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/core/CoreCneCnecsCreatorTest.java
#	data/rao-result/rao-result-io/rao-result-cne/core-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/core/CoreCneRemedialActionsCreatorTest.java
#	data/rao-result/rao-result-io/rao-result-cne/core-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/core/CoreCneTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweAdditionalConstraintSeriesCreator.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweCne.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweCneExporter.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweCneHelper.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweConstraintSeriesCreator.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweMonitoredSeriesCreator.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/main/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweRemedialActionSeriesCreator.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweAdditionalConstraintSeriesCreatorTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweCneDivergentAngleMonitoringTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweCneTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweMonitoredSeriesCreatorTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/SweRemedialActionSeriesCreatorTest.java
#	data/rao-result/rao-result-io/rao-result-cne/swe-cne-exporter/src/test/java/com/powsybl/openrao/data/raoresult/io/cne/swe/TieLineTest.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultJsonExporter.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultJsonImporter.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/AngleCnecResultArrayDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/ComputationStatusMapDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/CostResultMapDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/NetworkActionResultArrayDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/RangeActionResultArrayDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/RaoResultDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/deserializers/VoltageCnecResultArrayDeserializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/AngleCnecResultArraySerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/ComputationStatusMapSerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/CostResultMapSerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/NetworkActionResultArraySerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/RangeActionResultArraySerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/RaoResultJsonSerializerModule.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/RaoResultSerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/main/java/com/powsybl/openrao/data/raoresult/io/json/serializers/VoltageCnecResultArraySerializer.java
#	data/rao-result/rao-result-io/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresult/io/json/ImporterRetrocompatibilityTest.java
#	data/rao-result/rao-result-io/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultJsonConstantsTest.java
#	data/rao-result/rao-result-io/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresult/io/json/RaoResultRoundTripTest.java
#	data/rao-result/rao-result-io/rao-result-json/src/test/java/com/powsybl/openrao/data/raoresult/io/json/StateDeserializerTest.java
#	flowbased-computation/flowbased-computation-api/src/main/java/com/powsybl/openrao/flowbasedcomputation/FlowbasedComputation.java
#	flowbased-computation/flowbased-computation-api/src/main/java/com/powsybl/openrao/flowbasedcomputation/FlowbasedComputationProvider.java
#	flowbased-computation/flowbased-computation-impl/src/test/java/com/powsybl/openrao/flowbasedcomputation/impl/FlowbasedComputationImplTest.java
#	monitoring/src/main/java/com/powsybl/openrao/monitoring/Monitoring.java
#	monitoring/src/main/java/com/powsybl/openrao/monitoring/MonitoringInput.java
#	monitoring/src/main/java/com/powsybl/openrao/monitoring/results/RaoResultWithAngleMonitoring.java
#	monitoring/src/main/java/com/powsybl/openrao/monitoring/results/RaoResultWithVoltageMonitoring.java
#	monitoring/src/test/java/com/powsybl/openrao/monitoring/AngleMonitoringTest.java
#	monitoring/src/test/java/com/powsybl/openrao/monitoring/VoltageMonitoringTest.java
#	ra-optimisation/rao-api/src/test/java/com/powsybl/openrao/raoapi/RaoTest.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/AutomatonSimulator.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorContingencyScenarios.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimization.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorOneStateOnly.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorSecondPreventive.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/SensitivityFailureOvercostEvaluator.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/optimizationperimeters/CurativeOptimizationPerimeter.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/commons/optimizationperimeters/PreventiveOptimizationPerimeter.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/IteratingLinearOptimizer.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/fillers/FillersUtil.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/api/LinearOptimizationResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/api/OptimizationResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/api/PrePerimeterResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/api/SensitivityResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/AbstractFlowRaoResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/AutomatonPerimeterResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/CurativeWithSecondPraoResult.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/FailedRaoResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/IteratingLinearOptimizationResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/OneStateOnlyRaoResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/OptimizationResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/PrePerimeterSensitivityResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/SensitivityResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/SkippedOptimizationResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/result/impl/UnoptimizedRaoResultImpl.java
#	ra-optimisation/search-tree-rao/src/main/java/com/powsybl/openrao/searchtreerao/searchtree/algorithms/Leaf.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/castor/algorithm/AutomatonSimulatorTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorFullOptimizationTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/castor/algorithm/CastorSecondPreventiveTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/commons/objectivefunctionevaluator/SensitivityFailureOvercostEvaluatorTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/IteratingLinearOptimizerTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/fillers/AbstractFillerTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/fillers/CoreProblemFillerTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/linearoptimisation/algorithms/fillers/MnecFillerTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/AutomatonPerimeterResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/FailedRaoResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/FlowResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/OneStateOnlyRaoResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/OptimizationResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/PrePerimeterSensitivityResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/PreventiveAndCurativesRaoResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/SensitivityResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/SkippedOptimizationResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/result/impl/UnoptimizedRaoResultImplTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/searchtree/algorithms/LeafTest.java
#	ra-optimisation/search-tree-rao/src/test/java/com/powsybl/openrao/searchtreerao/searchtree/algorithms/SearchTreeTest.java
#	tests/src/test/java/com/powsybl/openrao/tests/steps/AngleMonitoringSteps.java
#	tests/src/test/java/com/powsybl/openrao/tests/steps/SearchTreeRaoSteps.java
#	tests/src/test/java/com/powsybl/openrao/tests/utils/CneHelper.java
#	tests/src/test/java/com/powsybl/openrao/tests/utils/Helpers.java
#	tests/src/test/java/com/powsybl/openrao/tests/utils/RaoUtils.java
@bqth29
merge main
8cd0793 
Signed-off-by: Thomas Bouquet <[email protected]>
@bqth29 bqth29 requested a review from Godelaine December 2, 2024 13:56
@Godelaine Godelaine merged commit c10b065 into main Dec 2, 2024
11 checks passed
@Godelaine Godelaine deleted the cleaning/rao-result-io branch December 2, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Godelaine Godelaine Godelaine approved these changes

Assignees
No one assigned
Labels
breaking-change Changes could break users' code cleaning This issue or pull request only concerns improving the overall state of the code PR: waiting-for-review This PR is waiting to be reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move RaoResult exporter in data/rao-result/rao-result-io
2 participants
@bqth29 @Godelaine