Skip to main content

Temporal Aggregation & Disaggregation for Modern Python (Polars-first)

Project description

aggdisagg

Temporal Aggregation & Disaggregation for Modern Python

Python Polars License: MIT uv PyPI GitHub

aggdisagg social preview

Install & try in 10 seconds:

pip install aggdisagg
import polars as pl
from aggdisagg import TemporalAligner
df = pl.DataFrame({"date": ["2020", "2021"], "y": [100.0, 120.0]})
print(TemporalAligner().fit_transform(df, datetime_col="date", target_col="y"))

aggdisagg is a clean, Polars-first Python library for converting time series between frequencies with perfect aggregation consistency.

  • Disaggregate low → high frequency (with indicators)
  • Aggregate high → low frequency (symmetric)
  • Works with Polars (primary), pandas, and xarray

Installation + Try in 10 Seconds

pip install "aggdisagg[all]" && python -c "
import polars as pl
from datetime import date
from aggdisagg import TemporalAligner
df = pl.DataFrame({'date':[date(2020,1,1),date(2021,1,1)], 'y':[1000.,1200.]})
print(TemporalAligner(method='uniform').fit_transform(df, datetime_col='date', target_col='y'))
"

Quickstart with TemporalAligner

import polars as pl
from datetime import date
from aggdisagg import TemporalAligner

df = pl.DataFrame({
    "date": [date(2020, 1, 1), date(2021, 1, 1), date(2022, 1, 1)],
    "y": [1200.0, 1500.0, 1350.0],      # low-frequency target
    "indicator": [100.0, 125.0, 110.0], # high-frequency indicator
})

aligner = TemporalAligner(
    method="chow-lin-opt",
    target_freq="1mo",
    agg="sum",
    indicator_cols=["indicator"],
)

monthly = aligner.fit_transform(df, datetime_col="date", target_col="y")
print(monthly.head())

# Perfect symmetric aggregation
yearly_back = aligner.aggregate(monthly, freq="1y")
print("Roundtrip OK:", (yearly_back["y_1y"] - df["y"]).abs().sum() < 1e-8)

# Plot (requires plotly)
monthly.plot()  # or use .plot() on the result if extended

Supported Methods

  • uniform
  • linear
  • denton / denton-cholette
  • chow-lin, chow-lin-opt (auto ρ via maxlog/minrss)
  • litterman, fernandez

All methods guarantee C @ y_high ≈ y_low exactly.

Why aggdisagg?

  • Polars-native core (lazy-friendly)
  • Perfect consistency by construction (C/D matrices)
  • Sklearn-style + fluent API
  • Real econometric methods (Denton quadratic, Chow-Lin GLS)
  • Excellent pandas / xarray interop
  • Production quality (typed, tested, documented)

First-User Tips & Current Limitations

Recommended starting point

aligner = TemporalAligner(method="chow-lin-opt", target_freq="1mo", agg="sum", indicator_cols=[...])
high = aligner.fit_transform(low_df, datetime_col="date", target_col="y")
back = aligner.aggregate(high, freq="1y")   # should match original low almost exactly

Output shape The returned DataFrame contains y_disaggregated (and y_std when uncertainty was computed). Original context columns are not automatically repeated (this was changed for robustness across Polars/pandas/object dates). You can expand dates yourself:

# Example: turn repeated yearly dates into proper monthly
high = high.with_columns(
    pl.date_range(high["date"].min(), high["date"].max(), "1mo", eager=True).alias("date")
)

Limitations (as of 1.1.0)

  • Date expansion in the output is basic (low-freq dates are not auto-expanded).
  • Uncertainty is a simple bootstrap and can be noisy or near-zero.
  • denton, litterman, fernandez implementations are functional but not as sophisticated as the classic R packages yet.
  • Only regular frequency ratios are supported.

See the CHANGELOG for the full list of recent robustness and correctness fixes.

  • Negative post-correction + NNLS ensemble
  • sktime / statsforecast compatible wrapper
# Hierarchical
rec = aligner.reconcile_hierarchical([nat_df, reg_df])

# Uncertainty
mean, std = aligner.predict_with_uncertainty()

# Lazy + xarray
lazy_high = aligner.fit_transform(lazy_df)
xa = aligner.to_xarray(high_df)

See examples/quickstart.py for complete gallery.

Development & Publishing

uv sync --all-extras
uv run pytest
uv run python examples/quickstart.py
uv build
# twine or uv publish

License

MIT


Built for data scientists who want temporal frequency conversion that just works.

Project details


Download files

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

Source Distribution

aggdisagg-1.2.1.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

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

aggdisagg-1.2.1-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file aggdisagg-1.2.1.tar.gz.

File metadata

  • Download URL: aggdisagg-1.2.1.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aggdisagg-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f2017be7f41be044a85ed0a5920d667ed8a31f26939ccd50ecd635acc3bcabe5
MD5 8484846eff994757957d681490069613
BLAKE2b-256 382ff3677dfb4da3541de732770d961f39c60acff67284ed246a44a023f71212

See more details on using hashes here.

Provenance

The following attestation bundles were made for aggdisagg-1.2.1.tar.gz:

Publisher: publish.yml on southu/aggdisagg

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

File details

Details for the file aggdisagg-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: aggdisagg-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aggdisagg-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24f25e810cdfba6f029a2cc911098ce483dc5ede52e6644a93eda76a32dc8d90
MD5 ebae1765be71c1d94ca79bd58696bce1
BLAKE2b-256 30f174b85ae3c01bbadb70367dc825921552d7a845c2140c4d881d62aee40f8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for aggdisagg-1.2.1-py3-none-any.whl:

Publisher: publish.yml on southu/aggdisagg

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page