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

documentation: ProcessScheduler #777

Merged
merged 76 commits into from Aug 3, 2023
Merged

documentation: ProcessScheduler #777

merged 76 commits into from Aug 3, 2023

Conversation

victorgarcia98
Copy link
Contributor

@victorgarcia98 victorgarcia98 commented Jul 28, 2023 •
edited by Flix6x

Description

This PR adds an extension of the toy tutorial using the ProcessScheduler. Moreover, it splits the first page of the toy-tutorial into a page for the setup and another for scheduling the battery.

Related Items

#768

FlexMeasures/screenshots#2

#729

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

@victorgarcia98
test: add shiftable_load fixture
f64709a 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
test: move fixture setup_dummy_sensors from test_reporting.py to conf…
35ca7e7 
…test.py

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
feat: add ShiftableLoadFlexModelSchema
99af08c 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
test: add ShiftableLoadFlexModelSchema tests
5216fa3 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
feat: add ShiftableLoadScheduler
8faf7e5 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
tests: add ShiftableLoadScheduler tests
b1472a5 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
test: add required parameter
e32767a 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feature/shiftable-load-scheduler
c1e9db5
@victorgarcia98
docs: improve docstrings
d26cd53 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feature/shiftable-load-scheduler
3016bdd
@victorgarcia98
fix: pandas 2.0 deprecated argument
d9151df 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
fix: pandas 2.0 deprecated argument
48eed71 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
feat: add minimum valuable version of the command flexmeasures add re…
b54af10 
…port shiftable.

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feature/shiftable-load-scheduler
84c23be
@victorgarcia98
docs: add changelog
850dd51 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
refactor: move TimeIntervalSchema to data.schemas.time
b099e25 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
refactor: rename cost_sensor to consumption_price_sensor
bf8c20d 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feature/shiftable-load-scheduler' into feature/cli/trig…
c9496a8 
…ger_shiftable_load
@victorgarcia98
feat: add forbid option
e820ffc 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
docs: add attribute description
405ca40 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
address change requests
c20669c 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feature/shiftable-load-scheduler
fbffd2e 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feature/shiftable-load-scheduler' into feature/cli/trig…
5b15830 
…ger_shiftable_load
@victorgarcia98
use consumption_price_sensor from flex_context
98d4a16 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feature/shiftable-load-scheduler' into feature/cli/trig…
a8b9ffa 
…ger_shiftable_load
@victorgarcia98
communicate consumption_price_sensor through the flex_context
c4e87f6 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add clarifying comments
de5e3cc 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
making block_invalid_starting_times_for_whole_process_scheduling work…
b991863 
… only when optimizing a INFLEXIBLE or SHIFTABLE load type.

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
remove consumption_price_sensor from flex_model
6822958 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add changelog entry
207eec6 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
fix test
db85ce4 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feature/cli/trigger_shiftable_load' into documentation/…
c380f37 
…shiftable_load_tutorial
Flix6x
Flix6x reviewed Jul 28, 2023
View reviewed changes
Copy link
Contributor

@Flix6x Flix6x left a comment

Choose a reason for hiding this comment

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

Just some quick notes from a quick read (I'm sorry to say I haven't been keeping myself up to date on the ProcessScheduler work, although I did see the name change, which I like).

Also, the pictures for the flexible loads would look better if their power sensors would define consumption in the positive direction. I believe we already have a dedicated attribute for that, something like consumption_is_positive.

documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
nhoening
nhoening requested changes Jul 28, 2023
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Great work!

I like your writing style :)

I found some improvements and inconsistencies.

documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-from-scratch.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-expanded.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
@victorgarcia98
fix typos and grammar
8d6602d 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Copy link
Contributor Author

Also, the pictures for the flexible loads would look better if their power sensors would define consumption in the positive direction. I believe we already have a dedicated attribute for that, something like consumption_is_positive.

Good idea!

An alternative would to store the results of the schedule in negative.

I tried to use this attribute but, apparently, it's not taking effect. consumption_is_positive is being used only in the function get_power_values, which is later used by the StorageScheduler.

Base automatically changed from feature/cli/trigger_shiftable_load to main August 1, 2023 16:31
@victorgarcia98
Merge branch 'main' into documentation/shiftable_load_tutorial
63a3099 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
make command to create default asset types only print on object creat…
11cd71b 
…ion, not when the entity already exist

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
output power instead of energy in ProcessScheduler
6864235 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
move back informative message
19ca0d4 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
address PR requests + adding table with results
e5444ce 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into documentation/shiftable_load_tutorial
5e3f26b
nhoening
nhoening requested changes Aug 2, 2023
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Thanks for the improvements, already very good.

documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
documentation/tut/toy-example-process.rst Outdated Show resolved Hide resolved
@victorgarcia98
add improvements
b58f077 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@nhoening
Copy link
Contributor

nhoening commented Aug 3, 2023

It doesn't look like there have been new commits?

@victorgarcia98
Merge remote-tracking branch 'origin/documentation/shiftable_load_tut…
49c3ec5 
…orial' into documentation/shiftable_load_tutorial
@victorgarcia98
Copy link
Contributor Author

I pushed b58f077 commit, please let me know if you are able to see it 😄

nhoening
nhoening approved these changes Aug 3, 2023
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Awesome!

@victorgarcia98 victorgarcia98 merged commit fcf77be into main Aug 3, 2023
4 checks passed
@victorgarcia98 victorgarcia98 deleted the documentation/shiftable_load_tutorial branch August 3, 2023 09:34
@Flix6x Flix6x added this to the 0.15.0 milestone Aug 3, 2023
@victorgarcia98 victorgarcia98 mentioned this pull request Aug 3, 2023
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhoening nhoening nhoening approved these changes

@Flix6x Flix6x Awaiting requested review from Flix6x

Assignees

@victorgarcia98 victorgarcia98

Labels
documentation Improvements or additions to documentation Scheduling
Projects
None yet
Milestone
0.15.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@victorgarcia98 @nhoening @Flix6x