Add color parameter to components and bulk color assignment via topology accessor #585
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
…s.py, flixopt/linear_converters.py):
- LinearConverter, Storage, Transmission, Source, Sink
- Boiler, Power2Heat, HeatPump, CoolingTower, CHP, HeatPumpWithSource
2. Added bulk color assignment methods to TopologyAccessor (flixopt/topology_accessor.py):
# Single component
flow_system.topology.set_component_color('Boiler', '#D35400')
# Multiple components - direct assignment
flow_system.topology.set_component_colors({
'Boiler': '#D35400',
'CHP': 'darkred',
})
# Multiple components - colorscale for groups
flow_system.topology.set_component_colors({
'Oranges': ['Solar1', 'Solar2'],
'Blues': ['Wind1', 'Wind2'],
})
# All components with colorscale
flow_system.topology.set_component_colors('turbo')
# Carrier color (affects bus colors)
flow_system.topology.set_carrier_color('electricity', '#FECB52')
3. Cache invalidation - _invalidate_color_caches() resets cached color dicts when colors change.
4. Updated documentation (docs/user-guide/results-plotting.md) - Fixed the incorrect flow_system.colors references to use flow_system.topology.
Read-only accessors still available:
flow_system.topology.component_colors # dict[str, str]
flow_system.topology.carrier_colors # dict[str, str]
flow_system.topology.bus_colors # dict[str, str]
Summary:
# Set colors only for components that don't have one yet
flow_system.topology.set_component_colors('turbo', overwrite=False)
# With dict - skips components that already have colors
flow_system.topology.set_component_colors({
'Boiler': 'red', # Skipped if Boiler already has a color
'CHP': 'blue', # Skipped if CHP already has a color
}, overwrite=False)
Returns only the colors that were actually assigned, so you can see what changed.
Contributor
📝 WalkthroughWalkthroughThis PR extends component constructors with an optional color parameter and introduces topology-based color management APIs (set_component_color, set_component_colors, set_carrier_color) to replace the prior colors accessor. It refactors color resolution logic in the plotting pipeline and updates documentation accordingly. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…nctionality:
def set_component_colors(
self,
colors: dict[str, str | list[str]] | str,
overwrite: bool = True,
) -> dict[str, str]:
components = self._fs.components
# Normalize to {label: color} mapping
if isinstance(colors, str):
color_map = process_colors(colors, list(components.keys()))
else:
color_map = {}
for key, value in colors.items():
if isinstance(value, list):
missing = [c for c in value if c not in components]
if missing:
raise KeyError(f"Components not found: {missing}")
color_map.update(process_colors(key, value))
else:
if key not in components:
raise KeyError(f"Component '{key}' not found")
color_map[key] = value
# Apply colors (respecting overwrite flag)
result = {}
for label, color in color_map.items():
if overwrite or components[label].color is None:
components[label].color = color
result[label] = color
self._invalidate_color_caches()
return result
Key improvements:
- Normalize all inputs to a {label: color} dict first
- Single pass to apply colors
- Cleaner error messages
- Shorter docstring with inline examples
FBumann
changed the title
Member
Author
|
coderabbitai review |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
flixopt/components.py (1)
1703-1718: Missingcolorparameter inSourceAndSinkfor API consistency.All other component classes (
LinearConverter,Storage,Transmission,Source,Sink) now accept acolorparameter, butSourceAndSinkdoes not. For a consistent API surface, consider adding thecolorparameter here as well.Suggested fix
def __init__( self, label: str, inputs: list[Flow] | None = None, outputs: list[Flow] | None = None, prevent_simultaneous_flow_rates: bool = True, meta_data: dict | None = None, + color: str | None = None, ): super().__init__( label, inputs=inputs, outputs=outputs, prevent_simultaneous_flows=(inputs or []) + (outputs or []) if prevent_simultaneous_flow_rates else None, meta_data=meta_data, + color=color, ) self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
🧹 Nitpick comments (1)
flixopt/linear_converters.py (1)
615-633: LGTM! Color parameter correctly added to HeatPumpWithSource.Completes the consistent addition of the
colorparameter across all LinearConverter subclasses.Optional: The class docstrings for
Boiler,Power2Heat,HeatPump,CoolingTower,CHP, andHeatPumpWithSourcecould be updated to document the newcolorparameter in their Args sections. However, since the parameter is inherited from the base class and the behavior is documented in the user guide, this is a nice-to-have improvement.
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.
Summary
Add
colorparameter to all component classes and provide bulk color assignment methods viaflow_system.topology.Changes
Added
colorparameter to component classes:LinearConverter,Storage,Transmission,Source,SinkBoiler,Power2Heat,HeatPump,CoolingTower,CHP,HeatPumpWithSourceAdded bulk color assignment methods to
TopologyAccessor:set_component_color(label, color)- single componentset_component_colors(colors, overwrite=True)- multiple componentsset_carrier_color(carrier, color)- carrier colors (affects bus colors)Usage
Type of Change
Testing
Checklist
Summary by CodeRabbit
Release Notes
New Features
colorparameter to component constructors for visualization customization at instantiation.set_component_color(),set_component_colors(), andset_carrier_color()for flexible color management.Documentation
✏️ Tip: You can customize this high-level summary in your review settings.