adding KPI's DG, OEF and OEM by Piranias · Pull Request #624 · rl-institut/multi-vector-simulator

Piranias · 2020-10-28T15:49:56Z

Changes proposed in this pull request:

in E3: added functions:

* add_degree_of_autonomy() and equation_degree_of_autonomy()
* add_onsite_energy_fraction() and equation_onsite_energy_fraction()
* add_add_add_onsite_energy_matching() and equation_onsite_energy_matching()

write tests for each function in Test_E3
add to changelog
added constants to constants_json_strings.py
added the three KPI functions to E0

The following steps were realized, as well (if applies):

Use in-line comments to explain your code
Write docstrings to your code (example docstring)
For new functionalities: Explain in readthedocs
Write test(s) for your new patch of code (pytests, assertion debug messages)
Update the CHANGELOG.md
Apply black (black . --exclude docs/)
Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)

Please mark above checkboxes as following:

Open
Done

❌ Check not applicable to this PR

_{For more information on how to contribute check the CONTRIBUTING.md.}

Piranias · 2020-10-28T15:58:10Z

unfortunately I changed the branch too late, apparently I transferred changes from PR #609 (read the docs) to this PR without noticing.
This should be solved when PR #609 is merged..

SabineHaas

Thank you @Piranias for adding these KPIs.

I requested some changes and here are my general comments:

I would add a section "Notes" before the "Returns" section and move the formulas to "Notes".
Please add the test function names (see #todo TEST)
I don't see how you added weighting in the calculation of the KPIs.
@Smarties would ask you for assertion messages, see E2 tests for examples

src/multi_vector_simulator/E3_indicator_calculation.py

Co-authored-by: Sabine Haas <[email protected]>

why i.e? self sufficiency is just another term for OEM Co-authored-by: Sabine Haas <[email protected]>

Co-authored-by: Sabine Haas <[email protected]>

…s_eland into feature/add_KPIs2

Piranias · 2020-11-03T09:41:10Z

Thank you @Piranias for adding these KPIs.

I requested some changes and here are my general comments:
* I would add a section "Notes" before the "Returns" section and move the formulas to "Notes".

I adjusted the style of the functions to all the other functions in this module. I would not change the styling of single functions now.

* Please add the test function names (see #todo TEST)

done

* I don't see how you added weighting in the calculation of the KPIs.

I did not add weighting in the functions but I used the "total_flow_of_energy_conversion_equivalent " which should already contain the weighting. But I'm not 100% sure if I added all the flows correctly, let's wait for @smartie2076 ti check this!

* @Smarties would ask you for assertion messages, see E2 tests for examples

done

Co-authored-by: Sabine Haas <[email protected]>

smartie2076

Yay, three more KPI!

I think a change is necessary for the feedin calculation.

Also, regarding the tests - I think you only wrote some for the equations, not the add_xy functions?

I see in the tests for the equations that you tested for one example, but not for the extreme values (can autonomy be > 1? What if excessive local generation but also excess for oem?

src/multi_vector_simulator/E3_indicator_calculation.py

smartie2076

Looking good!

src/multi_vector_simulator/E3_indicator_calculation.py

Piranias · 2020-11-10T16:34:40Z

Yay, three more KPI!

I think a change is necessary for the feedin calculation.

Also, regarding the tests - I think you only wrote some for the equations, not the add_xy functions?

I added the missing tests now!

I see in the tests for the equations that you tested for one example, but not for the extreme values (can autonomy be > 1? What if excessive local generation but also excess for oem?

The degree of autonomy can be > 1. See https://mvs-eland.readthedocs.io/en/latest/MVS_Outputs.html#degree-of-autonomy-da

the OEM cannot be > 1. But this is due to the simulation, I wouldn't know how to test this. For an explanation see: https://mvs-eland.readthedocs.io/en/latest/MVS_Outputs.html#onsite-energy-matching-oem

…s_eland into feature/add_KPIs2

Bachibouzouk · 2020-11-11T14:13:07Z

* Check if benchmark tests pass locally (`EXECUTE_TESTS_ON=master pytest`)

@Piranias - did you really run the EXECUTE_TESTS_ON=master pytest locally?

I found errors when I did

Piranias · 2020-11-12T17:15:09Z

* Check if benchmark tests pass locally (`EXECUTE_TESTS_ON=master pytest`)
@Piranias - did you really run the EXECUTE_TESTS_ON=master pytest locally?

I found errors when I did

ahh, I did before but forgot to run it again after adding the tests :( sorry. Did you work i out yet, or should I ?

Bachibouzouk · 2020-11-12T23:29:02Z

I fixed it in ced0b21, before we get our CI fixed, make sure you run the tests before you ask for review :)

Inia added 8 commits October 28, 2020 14:03

add degree of autonomy

398e2c2

add degree of autonomy

250cdc4

add changelog

59009e5

add tests

e3aa595

add E3 KPIs

e6a3fd5

add functions for DA, OEF and OEM

edac24d

add new constants

0b0614e

apply black

fa5dd88

Piranias changed the title ~~Feature/add kp is2~~ adding KPI's DG, OEF and OEM Oct 28, 2020

Piranias requested a review from SabineHaas October 28, 2020 15:58

Merge branch 'dev' into feature/add_KPIs2

ddd33f9

SabineHaas suggested changes Nov 2, 2020

View reviewed changes

Piranias and others added 12 commits November 3, 2020 10:14

Update src/multi_vector_simulator/E3_indicator_calculation.py

bed35e2

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

8fe51e7

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

426b6e0

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

725e178

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

42abbcf

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

de84f79

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

5970f67

why i.e? self sufficiency is just another term for OEM Co-authored-by: Sabine Haas <[email protected]>

Merge branch 'dev' into feature/add_KPIs2

7cbf4ba

Update src/multi_vector_simulator/E3_indicator_calculation.py

c512781

Co-authored-by: Sabine Haas <[email protected]>

adding assertion messages and test functions

3bf6d7e

Merge branch 'feature/add_KPIs2' of https://github.com/rl-institut/mv…

fa988b9

…s_eland into feature/add_KPIs2

fix typo

9dbbd17

Inia and others added 4 commits November 3, 2020 10:41

apply black

d1d4c50

Update src/multi_vector_simulator/E3_indicator_calculation.py

d536601

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

656e65c

Co-authored-by: Sabine Haas <[email protected]>

Update src/multi_vector_simulator/E3_indicator_calculation.py

d5bb782

Co-authored-by: Sabine Haas <[email protected]>

Piranias requested a review from smartie2076 November 3, 2020 12:28

Merge branch 'dev' into feature/add_KPIs2

15f5029

smartie2076 requested changes Nov 4, 2020

View reviewed changes

smartie2076 mentioned this pull request Nov 7, 2020

[Release] MVS 0.5.1 release #639

Closed

Piranias and others added 3 commits November 8, 2020 11:16

Merge branch 'dev' into feature/add_KPIs2

9f948db

add total generation to KPI and function for total_feedin

f5b0971

black

7e53f54

smartie2076 approved these changes Nov 10, 2020

View reviewed changes

src/multi_vector_simulator/E3_indicator_calculation.py Outdated Show resolved Hide resolved

Piranias and others added 5 commits November 10, 2020 16:16

Merge branch 'dev' into feature/add_KPIs2

a2298bd

move "add_total_feedin()" to E0

cddfbef

add tests add_... functions

fa15418

apply black

f872961

add test functions to doctrings

7922256

Piranias and others added 5 commits November 10, 2020 17:34

Merge branch 'dev' into feature/add_KPIs2

9b0fa81

update Changelog with total generation and total feedin

e9fb099

Merge branch 'feature/add_KPIs2' of https://github.com/rl-institut/mv…

08dd94a

…s_eland into feature/add_KPIs2

add new functions

1f9cc19

Merge branch 'dev' into feature/add_KPIs2

5fd8536

smartie2076 approved these changes Nov 11, 2020

View reviewed changes

Merge branch 'dev' into feature/add_KPIs2

e550883

SabineHaas self-requested a review November 11, 2020 10:06

SabineHaas approved these changes Nov 11, 2020

View reviewed changes

SabineHaas merged commit b74e2c0 into dev Nov 11, 2020

SabineHaas deleted the feature/add_KPIs2 branch November 11, 2020 10:06

smartie2076 added a commit that referenced this pull request Nov 11, 2020

Fix changelog entry for #624

651199d

smartie2076 mentioned this pull request Nov 11, 2020

MVS 0.5.2 #653

Merged

Conversation

Piranias commented Oct 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Piranias commented Oct 28, 2020

Uh oh!

SabineHaas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Piranias commented Nov 3, 2020

Uh oh!

smartie2076 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

smartie2076 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Piranias commented Nov 10, 2020

Uh oh!

Bachibouzouk commented Nov 11, 2020

Uh oh!

Piranias commented Nov 12, 2020

Uh oh!

Bachibouzouk commented Nov 12, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Piranias commented Oct 28, 2020 •

edited

Loading