kalix 0.2.3.dev5

Python interface for Kalix: hydrological modelling and Pixie (Gorilla-compressed) timeseries I/O

kalix (Python)

Python interface for Kalix, wrapping the Rust implementation via PyO3.

v0.1 ships read/write of the Pixie format (Kalix's Gorilla-compressed timeseries format, .pxt / .pxb paired files) as pandas DataFrames.

Planned for later releases: model loading & simulation, programmatic model building, optimisation.

Install

pip install kalix

Usage

import kalix

# Read a .pxt/.pxb pair into a DataFrame
df = kalix.read_pixie("results.pxb")
print(df.head())

# Write a DataFrame back out
kalix.write_pixie("out.pxb", df)

The DataFrame index is a UTC DatetimeIndex; each column is one timeseries.

read_pixie accepts either extension (or no extension) and finds both files:

kalix.read_pixie("results.pxb")  # same as
kalix.read_pixie("results.pxt")  # same as
kalix.read_pixie("results")

Building from source

Requires Rust (1.70+) and maturin.

# Editable install for development
cd python
maturin develop --release

# Build a wheel
maturin build --release

Tests

maturin develop
pytest python/tests