refactor/doc: make curtailment more robust, update README #100
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Correct fragility of
_check_resource_in_scenario()
to input type.What is the code doing
New tests are added in
test_curtailment.py
to pass all 'supported' input types tocalculate_curtailment_time_series
: set, list, and tuple, and to pass differently ordered lists and tuples. Initially, these tests fail.In
curtailment.py
,_check_resource_in_scenario()
is refactored to check for the set ofresources
being a subset ofscenario.state.get_grid().plant['type'].unique()
, ignoring all ordering.In
README.md
, update the call signatures ofpostreise/analyze
functions to match the reorganization that was done in #88.