adds an example with relation to pareto optimality #1613

Closed SGeeversAtVortech closed 1 month ago

In GitLab by @RSinnige on Jan 7, 2020, 17:21

This adds an additional example with relation to pareto optimality.

In GitLab by @RSinnige on Jan 8, 2020, 11:36

added 1 commit

c56df2f6 - adds an example with relation to pareto optimality

Compare with previous version

In GitLab by @RSinnige on Jan 8, 2020, 12:23

added 1 commit

f2ed8b63 - adds an example with relation to pareto optimality

Compare with previous version

In GitLab by @BernhardBecker on Jan 8, 2020, 21:25

added 5 commits

d9bd7a56 - adds an example with relation to pareto optimality
839e4903 - Modifications in pareto_optimality.rst
9559a9b8 - Removed goal_programming2; BlueRiver has been added therefore.
b26e718d - Correction line number
29a1bc7d - Merge branch 'new-example' of gitlab.com:deltares/rtc-tools

Compare with previous version

In GitLab by @BernhardBecker on Jan 8, 2020, 22:00

added 1 commit

7ab493b2 - deleted goal_programming2

Compare with previous version

In GitLab by @RSinnige on Jan 9, 2020, 03:29

added 1 commit

b3c232dd - adds further changes to adapt to the name changes in the example

Compare with previous version

In GitLab by @RSinnige on Jan 14, 2020, 11:35

unmarked as a Work In Progress

In GitLab by @RSinnige on Jan 14, 2020, 11:46

added 1 commit

3d42f81e - adds a style fix in rtctoolsapp

Compare with previous version

In GitLab by @RSinnige on Jan 15, 2020, 14:15

marked as a Work In Progress

In GitLab by @RSinnige on Jan 15, 2020, 14:39

unmarked as a Work In Progress

In GitLab by @RSinnige on Jan 15, 2020, 14:40

added 1 commit

52d5d5cf - adds further changes to adapt to the name changes in the example

Compare with previous version

In GitLab by @RSinnige on Jan 15, 2020, 16:59

marked as a Work In Progress

In GitLab by @RSinnige on Jan 15, 2020, 17:34

added 7 commits

8c9f32b0 - adds an example with relation to pareto optimality
ea3e214b - Modifications in pareto_optimality.rst
d305ba3f - Removed goal_programming2; BlueRiver has been added therefore.
cbe9d9f2 - Correction line number
c1f1dfd8 - adds an example with relation to pareto optimality
e0c8535f - deleted goal_programming2
6d7c174b - adds further changes to adapt to the name changes in the example

Compare with previous version

In GitLab by @RSinnige on Jan 15, 2020, 18:03

added 8 commits

0ee47a74 - 1 commit from branch master
a7db815b - adds an example with relation to pareto optimality
78224a54 - Modifications in pareto_optimality.rst
9366d7c8 - Removed goal_programming2; BlueRiver has been added therefore.
50578891 - Correction line number
51720e1d - adds an example with relation to pareto optimality
dd994286 - deleted goal_programming2
bd92074c - adds further changes to adapt to the name changes in the example

Compare with previous version

In GitLab by @RSinnige on Jan 15, 2020, 18:10

unmarked as a Work In Progress

In GitLab by @RSinnige on Jan 15, 2020, 18:39

added 1 commit

ccf0dd07 - adds an example with relation to pareto optimality based on the BlueRiver system

Compare with previous version

In GitLab by @vreeken on Jan 20, 2020, 14:10

Couple of notes from what I can see so far:

.py and .rst filenames should be snake_case. Same goes for example name folders. Please keep the style that's already there.
The "ALLOWED_MO_NAMES" thing feels rather hacky to me. I would suggest to either make the code such that it copies all .mo files (possibly to subfolders), or rename BlueRiver.mo to Example.mo (as it's about pareto optimality, not blue river).
It's confusing to call the example "Pareto optimality", but then have it in a folder name "BlueRiver". I would suggest to rename the latter to pareto_optimality
It would be nice to have consistent wrapping (at 80 or 100 characters) in the .rst file. At least for now.
There's a few typo's in the .rst file (e.g. "fullfill" instead of "fulfill"). Maybe run locally with the "sphinxcontrib.spelling" extension, and check issues that pop up in your .rst file.
Comments not properly indented in the "BlueRiver_example.py"
"# Any solver options can be set here" comment can be removed, as this is not a beginner example anymore.
The .vsz does not need to be included as far as I know.

In GitLab by @BernhardBecker on Jan 20, 2020, 17:37

Here my reactions: Comment: .py and .rst filenames should be snake_case. Same goes for example name folders. Please keep the style that's already there.: --> Makes sense. Blue River is a proper noun, so it should be Blue_River and not blue_river, when in snake_case, to distinguish it from any river with blue color.

Comment: It's confusing to call the example "Pareto optimality", but then have it in a folder name "BlueRiver". I would suggest to rename the latter to pareto_optimality: --> It is common practise to name the model according to the site (i. e. a part of the Earth). So the example should be called Blue_River rather than pareto_optimality. We will use the Blue River case to show other things (e. g. the closed loop approach), but the model (input, .mo and Blue_River.py) remains the same.

The .vsz does not need to be included as far as I know.: --> I would very much appreciate if we could find a way to include the vsz file here in the documentation, because I use this for training. In courses it has proven to be very helpful to make plots with Veusz (just a double click, zoom-in feature, add a line interactively etc.), so that we can focus on RTC-Tools rather than Matplotlib. If we can leave the vsz file here, we have everything on one place. If not, no problem, I can make a copy for trainings somewhere else. As a next step we could integrate the veusz file into the documentation.

In GitLab by @RSinnige on Jan 21, 2020, 15:22

added 3 commits

8c64827c - changes the name of the example folder to pareto_optimality
5dfb220c - applies spelling & grammar corrections in optimization/pareto_optimality.rst
261984c0 - corrects comments in BlueRiver_example.py

Compare with previous version

In GitLab by @RSinnige on Jan 21, 2020, 15:26

I have currently resolved the notes with exception of name changes and the .vsz files. I will modify the names when I know a clear decision is made.

In GitLab by @RSinnige on Jan 22, 2020, 15:21

marked as a Work In Progress

In GitLab by @RSinnige on Jan 22, 2020, 15:45

added 2 commits

22deaaeb - changes line lengths in BlueRiver_example.py and corrects the numbers
7b4f94a2 - changes line lengths in pareto_optimality_results.py

Compare with previous version

In GitLab by @RSinnige on Jan 22, 2020, 15:46

unmarked as a Work In Progress

In GitLab by @RSinnige on Jan 22, 2020, 15:50

added 2 commits

71809f6a - changes line lengths in BlueRiver_example.py and corrects the numbers
dd9042a2 - changes line lengths in pareto_optimality_results.py

Compare with previous version

In GitLab by @RSinnige on Jan 24, 2020, 13:13

marked as a Work In Progress

In GitLab by @RSinnige on Jan 24, 2020, 13:23

added 1 commit

3ccb9f67 - adds an example with relation to pareto optimality based on the BlueRiver system

Compare with previous version

In GitLab by @RSinnige on Jan 24, 2020, 13:58

added 1 commit

9590e97a - adds an example with relation to pareto optimality based on the BlueRiver system

Compare with previous version

In GitLab by @RSinnige on Jan 24, 2020, 14:16

I think most of the issues have been resolved. The names of the py and mo file are a compromise between the suggestions.

I have removed the vsz files. In my opinion, these files have no place in the documentation when they are not in use. As said, they can always be added when required or when they are used in the documentation.

In GitLab by @RSinnige on Jan 24, 2020, 14:18

added 1 commit

af121502 - adds an example with relation to pareto optimality based on the BlueRiver system

Compare with previous version

In GitLab by @RSinnige on Jan 24, 2020, 14:20

unmarked as a Work In Progress

In GitLab by @SGeeversAtVortech on Dec 8, 2022, 14:37

Closed, since this MR has been inactive for quite some time.

Deltares / rtc-tools

adds an example with relation to pareto optimality #1613