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

Add tutorial for the Reporters #825

Merged
merged 76 commits into from Aug 25, 2023
Merged

Add tutorial for the Reporters #825

merged 76 commits into from Aug 25, 2023

Conversation

victorgarcia98
Copy link
Contributor

Description

This PR adds a tutorial with two parts:

  1. Use AggregatorReporter to compute the headroom.
  2. Use ProfitReporter to compute the profit of the process of Tut. III under different policies.

Related Items

Screenshots in FlexMeasures/screenshots#4

  • 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
add CostReporter with tests
fa7b2de 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feature/reporting/cost-reporter
f76bd78
@victorgarcia98
rename CostReporter to profit reporter
3fe8a35 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
improve validation
82202f2 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add DataSource field to flexmeasures add report
292c893 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
fix: use source and make it an optional field
d53bcdb 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge remote-tracking branch 'origin/main' into feature/reporting/cos…
a0af4ba 
…t-reporter
@victorgarcia98
Merge remote-tracking branch 'origin/feature/reporting/cost-reporter'…
a6d77f7 
… into feature/reporting/cost-reporter
@victorgarcia98
Merge branch 'feature/reporting/cost-reporter' into feature/cli/add-r…
0788a5f 
…eport-from-data-source
@victorgarcia98
Merge branch 'feature/cli/add-report-from-data-source' into feautre/r…
dd44355 
…eporting/make-source-optional-aggregator-reporter
@victorgarcia98
fix tests
3e48cdd 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add test + fix case of multiple sources
0300af2 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Add --id and --show-attributed field to flexmeasures show data-sources.
2429242 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add sensors
1348eeb 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feautre/reporting/make-source-optional-aggregator-repor…
b3470f5 
…ter' into documentation/reporting/reporter-tutorial

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add new command to create basic sources for the available reporters.
851de9c 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feature/cli/add-report-from-data-source' into feautre/r…
c92e587 
…eporting/make-source-optional-aggregator-reporter
@victorgarcia98
set sensor in ouput bdf
faa1881 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feautre/reporting/make-source-optional-aggregator-repor…
bb53bc4 
…ter' into documentation/reporting/reporter-tutorial
@victorgarcia98
set resolution
1e418b6 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'feautre/reporting/make-source-optional-aggregator-repor…
f078e54 
…ter' into documentation/reporting/reporter-tutorial
@victorgarcia98
add reporter tutorial
864add7 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98 victorgarcia98 marked this pull request as ready for review August 18, 2023 07:34
@victorgarcia98 victorgarcia98 self-assigned this Aug 18, 2023
@victorgarcia98 victorgarcia98 added documentation Improvements or additions to documentation Reporting labels Aug 18, 2023
@victorgarcia98
update docstring
8b27f71 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into feautre/reporting/make-source-optional-aggre…
da6b3a4 
…gator-reporter
@victorgarcia98
add changelog entry
7692e94 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
Base automatically changed from feature/reporting/cost-reporter to main August 22, 2023 15:27
victorgarcia98 and others added 2 commits August 24, 2023 09:13
@victorgarcia98
Merge branch 'main' into documentation/reporting/reporter-tutorial
4901e80 
Signed-off-by: Victor <victor@seita.nl>
@Flix6x
styling: rephrasings and one more typo
b010d9d 
Signed-off-by: F.N. Claessen <felix@seita.nl>
Flix6x
Flix6x requested changes Aug 24, 2023
View reviewed changes
documentation/tut/toy-example-reporter.rst Show resolved Hide resolved
flexmeasures/cli/data_add.py Outdated Show resolved Hide resolved
documentation/tut/toy-example-reporter.rst Outdated Show resolved Hide resolved
@victorgarcia98
add new dependency vl-convert-python
aa54299 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
fix: equal_v out of bound
f4d9ff5 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98 victorgarcia98 mentioned this pull request Aug 24, 2023
Open
@victorgarcia98
rename Losses to Costs
e539eba 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
doc change
b1e13d6 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into documentation/reporting/reporter-tutorial
c55e425 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge remote-tracking branch 'origin/documentation/reporting/reporter…
1c7e86c 
…-tutorial' into documentation/reporting/reporter-tutorial

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
Flix6x
Flix6x reviewed Aug 25, 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.

Can you add the main changelog item with mention of creating a whole new tutorial dealing with reporting? It's quite the milestone, and shouldn't go unmentioned.

I'm also wondering whether the reporting tutorial should have a warning mentioning that this functionality is in an early stage. (Given that we may still rename the PandasReporter, for example).

documentation/cli/change_log.rst Outdated Show resolved Hide resolved
@victorgarcia98
update CLI changelog entry
e6bcd08 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add warning message in the tutorial
b712f10 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge branch 'main' into documentation/reporting/reporter-tutorial
4947e0a
@victorgarcia98
add changelog entry
5cced1a 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
add `a to entry
f73390f 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Copy link
Contributor Author

I'm also wondering whether the reporting tutorial should have a warning mentioning that this functionality is in an early stage. (Given that we may still rename the PandasReporter, for example).

Good point! I've added a warning to the tutorial.

@Flix6x
Update toy-example-reporter.rst
4d4f0a5 
small typo

Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com>
@victorgarcia98
rename attributes to asset_attributes
1f774b7 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@victorgarcia98
Merge remote-tracking branch 'origin/documentation/reporting/reporter…
baefb37 
…-tutorial' into documentation/reporting/reporter-tutorial
@victorgarcia98 victorgarcia98 merged commit 0667a0c into main Aug 25, 2023
3 of 5 checks passed
@victorgarcia98 victorgarcia98 deleted the documentation/reporting/reporter-tutorial branch August 25, 2023 09:56
victorgarcia98 added a commit that referenced this pull request Aug 25, 2023
@victorgarcia98
ammend changes in linear_optimiation after commiting the in PR #825
e48afd6 
Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
victorgarcia98 added a commit that referenced this pull request Aug 25, 2023
@victorgarcia98
ammend changes in linear_optimiation after commiting the in PR #825 (#…
5113257 
…836)

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
@nhoening nhoening mentioned this pull request Aug 29, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Flix6x Flix6x Flix6x approved these changes

Assignees

@victorgarcia98 victorgarcia98

Labels
documentation Improvements or additions to documentation Reporting
Projects
None yet
Milestone
0.16.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@victorgarcia98 @Flix6x