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.

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

Fix loader and examples #399

Merged
merged 27 commits into from
Aug 8, 2024
Merged

Fix loader and examples #399

merged 27 commits into from
Aug 8, 2024

Conversation

nick-harder
Copy link
Member

@nick-harder nick-harder commented Aug 6, 2024

Description

  • check if availability_df containt values >1 and warn user if so
  • fix these values automatically by normalizing them
  • also check in the power plant itself when calculating max_power if availability is larger than max_power
  • restructure examples for easier understanding
  • pack all feature example to example_01 and all learning to example_02
  • add a full year DRL scenario from the fit paper
  • all year examples are now as example_03

Checklist

Please check all applicable items:

  • Code changes are sufficiently documented (docstrings, inline comments, doc folder updates)
  • New unit tests added for new features or bug fixes
  • Existing tests pass with the changes
  • Reinforcement learning examples are operational (for DRL-related changes)
  • Code tested with both local and Docker databases
  • Code follows project style guidelines and best practices
  • Changes are backwards compatible, or deprecation notices added
  • New dependencies added to pyproject.toml
  • A note for the release notes doc/release_notes.rst of the upcoming release is included
  • Consent to release this PR's code under the GNU Affero General Public License v3.0

-fix these values automatically by normalizing them
-also check in the power plant itself when calculating max_power if availability is larger than max_power
-restructure examples for easier understanding
-pack all feature example to example_01 and all learning to example_02
-add a full year DRL scenario from the fit paper
-all year examples are now as example_03
Copy link

codecov bot commented Aug 6, 2024

Codecov Report

Attention: Patch coverage is 28.57143% with 15 lines in your changes missing coverage. Please review.

Project coverage is 77.40%. Comparing base (8b7d076) to head (219eb77).

Files Patch % Lines
assume/common/utils.py 9.09% 10 Missing ⚠️
assume/scenario/loader_csv.py 33.33% 4 Missing ⚠️
assume/units/powerplant.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #399      +/-   ##
==========================================
- Coverage   77.59%   77.40%   -0.19%     
==========================================
  Files          47       47              
  Lines        5797     5816      +19     
==========================================
+ Hits         4498     4502       +4     
- Misses       1299     1314      +15     
Flag Coverage Δ
pytest 77.40% <28.57%> (-0.19%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

assume/common/utils.py Outdated Show resolved Hide resolved
examples/examples.py Show resolved Hide resolved
examples/examples.py Show resolved Hide resolved
examples/examples.py Show resolved Hide resolved
Copy link
Member

@maurerle maurerle left a comment

Choose a reason for hiding this comment

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

I have some small remarks :)

And I updated the docs to have proper footnotes

assume/scenario/loader_csv.py Show resolved Hide resolved
assume/scenario/loader_csv.py Outdated Show resolved Hide resolved
@nick-harder nick-harder dismissed kim-mskw’s stale review August 8, 2024 10:55

all issues have been adressed

@nick-harder nick-harder merged commit efea877 into main Aug 8, 2024
3 of 5 checks passed
@nick-harder nick-harder deleted the fix-loader-and-examples branch August 8, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants