cellpy-core

The core engine of cellpy: fast, thread-safe processing of battery-cycling raw data. Given a raw data frame (polars, native schema — or pandas via the legacy bridge), it finds all steps and cycles and builds per-step and per-cycle summary tables. It is designed to be small, schema-injected, and easy for cellpy developers to build on and extend; instrument loaders, file IO, and unit handling stay out of the core.

import polars as pl
from cellpycore import Data, make_step_table, make_summary

data = Data.from_raw_frame(pl.read_parquet("my_native_raw.parquet"))
make_step_table(data, nom_cap=1.0)
make_summary(data)
print(data.steps, data.summary)

Installing

Available on PyPI as cellpycore:

pip install cellpycore

Source: https://github.com/cellpy/cellpy-core

Documentation

Full documentation (built with Zensical, hosted on Read the Docs): https://cellpy-core.readthedocs.io/

Key pages:

Using cellpy-core standalone (slim-consumer guide) — get step tables and per-cycle summaries from a native-schema polars frame without full cellpy.
Harmonized raw format specification
The Data object
API reference (autogenerated from docstrings)
Example notebooks

Build the docs locally with uv run --group docs zensical serve (config in zensical.toml; notebook-regeneration instructions in docs/examples/index.md).

Developing

This project uses uv as the package manager and build tool. uv is a fast Python package installer and resolver, written in Rust.

Prerequisites

Install uv:

pip install uv

Development Workflow

Install all dependencies (creates .venv automatically):

uv sync

Adding new dependencies:

# Add a new package
uv add <package-name>

# Add a new development package
uv add --dev <package-name>

Running tests:

uv run pytest

Common Commands

Reinstall dependencies from the lock file: uv sync
Remove a package: uv remove <package-name>
Upgrade all packages within constraints: uv sync --upgrade
Show the dependency tree: uv tree

For more information about uv, visit the official documentation.

Development Status
- 4 - Beta
Intended Audience
- Developers
- Science/Research
Programming Language
- Python :: 3.13
Topic
- Scientific/Engineering

Download files

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

Source Distribution

cellpycore-0.2.4.tar.gz (880.2 kB view details)

Uploaded Jul 24, 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.

cellpycore-0.2.4-py3-none-any.whl (92.5 kB view details)

Uploaded Jul 24, 2026 Python 3

File details

Details for the file cellpycore-0.2.4.tar.gz.

File metadata

Download URL: cellpycore-0.2.4.tar.gz
Upload date: Jul 24, 2026
Size: 880.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for cellpycore-0.2.4.tar.gz
Algorithm	Hash digest
SHA256	`82ab2c21a5ff7b51bd558880314ad51fd148aac82c902796b88fb0d708204ee0`
MD5	`26a2d4bddce1cb2938acdb3916d704b0`
BLAKE2b-256	`d21b24ad2cca3a5017f90294c0a519efaa942562f89882843c0d5a70919470c3`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellpycore-0.2.4.tar.gz:

Publisher: release.yml on cellpy/cellpy-core

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: cellpycore-0.2.4.tar.gz
- Subject digest: 82ab2c21a5ff7b51bd558880314ad51fd148aac82c902796b88fb0d708204ee0
- Sigstore transparency entry: 2237473368
- Sigstore integration time: Jul 24, 2026
Source repository:
- Permalink: cellpy/cellpy-core@6aebdb33f0b2a7babe95e71f6f72e23e3b969864
- Branch / Tag: refs/tags/v0.2.4
- Owner: https://github.com/cellpy
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@6aebdb33f0b2a7babe95e71f6f72e23e3b969864
- Trigger Event: release