Feature/multiple rule curve cr 24 by nikolaredstork · Pull Request #113 · rte-i/Antares_Simulator

nikolaredstork · 2024-12-09T20:44:03Z

This PR implements the Multiple Rule Curves for Hydro Reservoirs as an optional new feature, RTE-I's CR24.
Specification: https://rteinternational.sharepoint.com/:w:/s/AntaresUser'sClub-Interne/EbkQpgbTrtBIkT2jQiIbbaQB8mBLrJWASFaGdXPs3cNA8Q?e=ekSAkf

…erage reservoir levels

…h input files reservoir levels should be loaded

flomnes

This looks very nice, a few minor remarks

Rename reservoir levels => rule curves
Place all loading logic into the loader class implementations (single / scenarized)

Thanks !

flomnes · 2025-05-22T07:11:58Z

src/libs/antares/study/area/list.cpp

            ret = area.hydro.series->saveToFolder(area.id, buffer, hydroPmax) && ret;
+
+            buffer.clear() << folder << SEP << "input" << SEP << "hydro";
+            ret = area.hydro.series->reservoirLevels.saveToFolder(area.id, buffer) && ret;


Suggested change

ret = area.hydro.series->reservoirLevels.saveToFolder(area.id, buffer) && ret;

ret = area.hydro.series->ruleCurves.saveToFolder(area.id, buffer) && ret;

Regarding naming convention, from my point of view, it is natural to stay as it is, since in the Antares documentation we called it reservoir levels. If new Antares Simulator developer starts to work, he would search for object called reservoirLevels, not ruleCurves. Nevertheless, if you don't agree please tell me, It won't be hard to change it. Thanks.

flomnes · 2025-05-22T07:12:18Z

src/libs/antares/study/area/list.cpp

              "Value not supported for study.parameters.compatibility.hydroPmax");
        }

+        ret = area.hydro.series->reservoirLevels.loadReservoirLevels(


Suggested change

ret = area.hydro.series->reservoirLevels.loadReservoirLevels(

ret = area.hydro.series->ruleCurves.loadFromFolder(

flomnes · 2025-05-22T07:13:16Z

src/libs/antares/study/include/antares/study/parts/hydro/hydroreservoirlevels.h

+    // This functionality will no longer be required once the UI is fully deprecated.
+    Matrix<double> standardReservoirLevelMatrix;
+
+    TimeSeriesNumbers& timeseriesNumbers;


Place this member before TimeSeries members for initialization reasons

flomnes · 2025-05-22T07:14:57Z

src/libs/antares/study/parts/hydro/hydroreservoirlevels.cpp

+    standardReservoirLevelMatrix.fillColumn(ReservoirLevels::maximum, 1.);
+    standardReservoirLevelMatrix.fillColumn(ReservoirLevels::average, 0.5);


If standardReservoirLevelMatrix is only required for the GUI, add ui or GUI in it's name

flomnes · 2025-05-22T07:15:58Z

src/libs/antares/study/parts/hydro/hydroreservoirlevels.cpp

+bool ReservoirLevels::loadReservoirLevels(
+  const std::string& areaID,
+  const std::filesystem::path& folder,
+  bool usedBySolver,
+  Parameters::Compatibility::HydroRuleCurves hydroRuleCurves)


Isn't there a ReservoirLevelsLoader class ? If so, why does ReservoirLevels still has some code related to loading ?

I've created RuleCurvesLoaderService class to support this functionality. Please check it out, and if you have additional comments, please add it.

flomnes · 2025-05-22T07:18:04Z

src/solver/hydro/include/antares/solver/hydro/management/HydroInputsChecker.h

+    //! check reservoir levels
+    bool checkReservoirLevels(uint year);


rule curves

flomnes · 2025-05-22T07:18:10Z

src/solver/hydro/management/HydroInputsChecker.cpp

 {
    prepareInflows_.Run(year);
    minGenerationScaling_.Run(year);
+    if (!checkReservoirLevels(year))


rule curves

flomnes

Also, do you use the existing hydro prefix for scenariobuilder.dat ?

@flomnes Since we are using the same object for storing TimeSeriesNumbers, we are using the same scenario builder, so the answer is yes.

flomnes · 2025-05-22T07:27:49Z

Finally, could you point to our repository instead of RTE-i's fork ?

nikolaredstork added 30 commits November 27, 2024 21:19

Introduce new Time-Series that will represent maximum, minimum and av…

c5a62f3

…erage reservoir levels

Intoduction to the new global parameter that will determine from whic…

6bb1351

…h input files reservoir levels should be loaded

Introduce reservoir levels objects into constructor

a4d744f

Add comments

555b4f0

Clang format and hydro reservoir level check

9d92b2e

Reservoir Levels load function

30043fb

Introduce new function for loading old reservoir levels files

3bea9b2

Add checks in solver

ba35f60

Clang format

7377d61

Clang format

c06853e

Implement new objects to solver

7d04962

Bug Fix

ac6a6e2

Refactoring and Unit tests

02a84ef

Clang format

ff11399

Merge branch 'develop' into feature/multiple-rule-curve-cr24

b1f9c24

Reservoir levels check revert

8338a9b

Hydro Levels Check Fix

29a24d5

Use getColum function

ebffd6c

Excluding unnecessary code

130ece3

Refactoring

e4fba4f

Save useScenarizedReservoirLevels value

be6c31a

Clang format

baa68bd

Change function name

26068f7

Additional check in reservoir levels check function

2b880c7

Modification of load function

35aea9b

Unit tests-Loading scenarized reservoir levels

f013a51

clang format

62604fa

Refactor hydro reservoir check

25da0ea

Bug fix

b21a8c0

Unit tests for hydro inputs checker

b8cd961

nikolaredstork added 9 commits April 1, 2025 08:58

Move flag to compatibility part

f52a1ba

Clang format

57c4236

Clang format

0396f76

Hydro rule curves compatibility

b3dbcc5

Clang format

35a9d82

Documentation update

3ea013b

Merge branch 'develop' into feature/multiple-rule-curve-cr-24

e409e5d

Unit tests

ee5bd18

Clang format

fa36c6d

nikolaredstork requested a review from flomnes April 2, 2025 07:24

Add study version conversion

559ffc5

flomnes reviewed May 22, 2025

View reviewed changes

Change function name

897a4ec

nikolaredstork force-pushed the feature/multiple-rule-curve-cr-24 branch 3 times, most recently from e8ceb21 to 897a4ec Compare May 29, 2025 21:56

nikolaredstork added 12 commits May 30, 2025 00:45

Swithc places for initialization reasons

9cb9428

Change name convention for object that communicate with GUI

c3b8ca4

Clang Format

99e6860

Name convetion modification

606d3bc

Naming convention second part

ffc10cb

Change name of files

9beb916

Move load from folder function to RuleCurvesLoader class

3db5592

Loader Service Class

e9c588c

Add createRuleCurvesLoader in Service class

5ba5657

Remove unnecessary code and modify unit tests

9196bd6

Merge branch 'develop' into feature/multiple-rule-curve-cr-24

c0c5944

Code smells

acfe1c2

	ret = area.hydro.series->reservoirLevels.saveToFolder(area.id, buffer) && ret;
	ret = area.hydro.series->ruleCurves.saveToFolder(area.id, buffer) && ret;

	ret = area.hydro.series->reservoirLevels.loadReservoirLevels(
	ret = area.hydro.series->ruleCurves.loadFromFolder(

		standardReservoirLevelMatrix.fillColumn(ReservoirLevels::maximum, 1.);
		standardReservoirLevelMatrix.fillColumn(ReservoirLevels::average, 0.5);

		//! check reservoir levels
		bool checkReservoirLevels(uint year);

Conversation

nikolaredstork commented Dec 9, 2024 • edited by Milos-RTEi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flomnes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nikolaredstork May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flomnes left a comment • edited by nikolaredstork Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

flomnes commented May 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nikolaredstork commented Dec 9, 2024 •

edited by Milos-RTEi

Loading

nikolaredstork May 23, 2025 •

edited

Loading

flomnes left a comment •

edited by nikolaredstork

Loading