tsam_xarray

DataArray in, DataArray out — multi-dimensional time series aggregation with tsam and xarray.

The problem

Energy system data is multi-dimensional — variables, regions, scenarios, years. Some dimensions should be clustered together (solar and wind profiles in the same region should see the same typical days), while others need independent clustering (each scenario has its own weather patterns).

Multi-dimensional input data

tsam works on flat DataFrames. With multi-dimensional data, you end up writing boilerplate: loop over scenarios, convert to DataFrame, aggregate, extract results, convert back, concatenate, hope the dims line up. Accuracy metrics come back as unlabeled pd.Series. Saving a clustering means managing raw dicts.

The solution

import tsam_xarray

result = tsam_xarray.aggregate(
    da,                                    # (time, variable, region, scenario)
    time_dim="time",
    cluster_dim=["variable", "region"],    # clustered together
    n_clusters=4,
)
# scenario is sliced independently — each gets its own clustering

Everything comes back as labeled xarray objects:

result.cluster_representatives   # (scenario, cluster, timestep, variable, region)
result.reconstructed             # same shape as input
result.cluster_assignments       # (scenario, period)

Accuracy metrics preserve all dimensions — see exactly where the approximation is good or bad:

Per-column RMSE across all dimensions

result.accuracy.rmse             # DataArray (scenario, variable, region)
result.accuracy.weighted_rmse    # DataArray (scenario,) — per-slice summary

Save, load, reuse

# Save clustering (not the data — just the mapping)
result.clustering.to_json("clustering.json")

# Load and inspect — no original data needed
clustering = tsam_xarray.load_clustering("clustering.json")
clustering.n_clusters              # 4
clustering.cluster_assignments     # DataArray (scenario, period)
clustering.cluster_occurrences     # DataArray (scenario, cluster)

# Apply to new data or disaggregate optimization results
new_result = clustering.apply(new_da)
full_timeseries = clustering.disaggregate(optimized_data)

Tuning

Find optimal hyperparameters across all slices:

grid = tsam_xarray.grid_search(
    da,
    time_dim="time",
    cluster_dim=["variable", "region"],
    timesteps=np.geomspace(2, 48, num=12, dtype=int),  # sparse search
)
grid.summary_matrix["rmse"]        # heatmap-ready (n_clusters, n_segments)
grid.accuracy["weighted_rmse"]     # per-slice weighted RMSE for every config

Installation

pip install tsam-xarray

Documentation

Full docs with interactive examples: tsam-xarray.readthedocs.io

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tsam_xarray-0.6.1.tar.gz (562.9 kB view details)

Uploaded Jul 9, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

tsam_xarray-0.6.1-py3-none-any.whl (26.5 kB view details)

Uploaded Jul 9, 2026 Python 3

File details

Details for the file tsam_xarray-0.6.1.tar.gz.

File metadata

Download URL: tsam_xarray-0.6.1.tar.gz
Upload date: Jul 9, 2026
Size: 562.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tsam_xarray-0.6.1.tar.gz
Algorithm	Hash digest
SHA256	`a07631f8d4c3e8a4f093fd5fb3c963915ce1e8fe57dfed712ba3e0f34f2fd6cb`
MD5	`1b5448101c9e14065be7c5263289e721`
BLAKE2b-256	`867a1e192d88e3bd04a9ddf7e58e7c0df085e7fb8c77961412836316d9f4689b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for tsam_xarray-0.6.1.tar.gz:

Publisher: publish.yaml on FBumann/tsam_xarray

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: tsam_xarray-0.6.1.tar.gz
- Subject digest: a07631f8d4c3e8a4f093fd5fb3c963915ce1e8fe57dfed712ba3e0f34f2fd6cb
- Sigstore transparency entry: 2128428269
- Sigstore integration time: Jul 9, 2026
Source repository:
- Permalink: FBumann/tsam_xarray@1e879655accef7865bda2b23da28a7036f26dbea
- Branch / Tag: refs/tags/v0.6.1
- Owner: https://github.com/FBumann
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yaml@1e879655accef7865bda2b23da28a7036f26dbea
- Trigger Event: push