feat: Adding new hydro structs from PSY 5 and add backward compatibility. #209
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds new hydro power structs (HydroReservoir and HydroTurbine) for PSY 5 compatibility and implements backward compatibility through an upgrader that converts legacy HydroEnergyReservoir components.
Key changes:
- New hydro component models (
HydroReservoir,HydroTurbine) and cost structure (HydroReservoirCost) - PSY4 to PSY5 upgrader that converts
HydroEnergyReservoirinto separate reservoir and turbine components - Comprehensive test coverage for new models and upgrade functionality
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/r2x/models/generators.py |
Adds new HydroReservoir and HydroTurbine model classes |
src/r2x/models/costs.py |
Adds HydroReservoirCost class and example method for HydroGenerationCost |
src/r2x/enums.py |
Adds ReservoirDataType enum for reservoir data types |
src/r2x/upgrader/psy4_to_psy5.py |
Implements upgrader logic to convert legacy components |
tests/upgrader/test_psy4_to_psy5.py |
Tests for the PSY4 to PSY5 upgrader functionality |
tests/test_hydro_reservoir.py |
Tests for new hydro component models |
src/r2x/models/__init__.py |
Updates imports to include new components |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/r2x/upgrader/psy4_to_psy5.py
Outdated
| "intake_elevation": ext.get("intake_elevation", 0.0), | ||
| "head_to_volume_factor": ext.get("head_to_volume_factor", {"points": []}), | ||
| "operation_cost": HydroReservoirCost().model_dump(round_trip=True), | ||
| "level_data_type": str(ReservoirDataType.USABLE_VOLUME), # NOTE: Is this a good default? |
There was a problem hiding this comment.
[nitpick] The inline comment raises a question about the default value but provides no guidance. Consider either removing the comment if this is the intended default, or documenting why this specific default was chosen.
Suggested change
| "level_data_type": str(ReservoirDataType.USABLE_VOLUME), # NOTE: Is this a good default? | |
| "level_data_type": str(ReservoirDataType.USABLE_VOLUME), # Default to USABLE_VOLUME to match typical reservoir usage in PSY5 |
jarry7
reviewed
Sep 9, 2025
jarry7
reviewed
Sep 9, 2025
| return HydroGenerationCost( | ||
| fixed=0.0, | ||
| variable=CostCurve( | ||
| value_curve=LinearCurve(10), power_units=UnitSystem.NATURAL_UNITS, vom_cost=LinearCurve(5.0) |
jarry7
reviewed
Sep 9, 2025
| ), | ||
| ) | ||
| efficiency: float = 1.0 | ||
| conversion_factor: float = 1.0 |
Collaborator
Author
There was a problem hiding this comment.
mimic psy5. assumptions
jarry7
reviewed
Sep 9, 2025
| ) | ||
| active_power_pump: float = 0.0 | ||
| efficiency: TurbinePump = TurbinePump(pump=1.0, turbine=1.0) | ||
| transition_time: TurbinePump = TurbinePump(pump=0.0, turbine=0.0) |
jarry7
reviewed
Sep 9, 2025
jarry7
previously requested changes
Sep 9, 2025
Contributor
jarry7
left a comment
jarry7
left a comment
There was a problem hiding this comment.
Small comments provided in-line.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: pesap <pesap@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Plexos test is broken and will be migrated to r2x-plexos eventually.