Skip to content

Refactor/tsam xarray simplify #656

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.

Sign up for GitHub

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

Closed
FBumann wants to merge 2 commits into from
Closed

Refactor/tsam xarray simplify #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44e5163
refactor!: remove ClusteringPlotAccessor, metrics, original_data, inc…
FBumann Apr 1, 2026
637fe77
test: add expansion regression tests for cluster → optimize → expand …
FBumann Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions flixopt/clustering/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

Example usage:

# Cluster a FlowSystem to reduce timesteps
from tsam import ExtremeConfig

fs_clustered = flow_system.transform.cluster(
Expand All @@ -15,21 +14,14 @@
extremes=ExtremeConfig(method='new_cluster', max_value=['Demand|fixed_relative_profile']),
)

# Access clustering structure (available before AND after IO)
clustering = fs_clustered.clustering
print(f'Number of clusters: {clustering.n_clusters}')
print(f'Clustering info: {clustering.clustering_result}') # tsam_xarray ClusteringResult
print(f'Clustering result: {clustering.clustering_result}')

# Access tsam_xarray AggregationResult for detailed analysis
# NOTE: Only available BEFORE saving/loading. Lost after IO.
# Access tsam_xarray AggregationResult (only before saving/loading)
result = clustering.aggregation_result
result.cluster_representatives # DataArray with aggregated time series
result.accuracy # AccuracyMetrics (rmse, mae)

# Save and load - structure preserved, AggregationResult access lost
fs_clustered.to_netcdf('system.nc')
# Use include_original_data=False for smaller files (~38% reduction)
fs_clustered.to_netcdf('system.nc', include_original_data=False)
result.cluster_representatives # DataArray
result.accuracy # AccuracyMetrics

# Expand back to full resolution
fs_expanded = fs_clustered.transform.expand()
Expand Down
Loading
Loading