PyDPEET Documentation#

PyDPEET is a Python package for reading, standardising, processing, evaluating, and visualising battery measurement data. It is designed to reduce repeated project-specific data wrangling, make processing pipelines easier to reproduce, and provide a shared basis for research and engineering workflows across different cyclers, experiments, and institutions.

Note

The project is under active development. New features, fixes, and quality improvements are added frequently, and users should expect regular updates.

What you will find in this documentation#

The documentation is organised around the most important ways people use PyDPEET:

  • Installation explains how to install PyDPEET from PyPI, starting from Python or Miniconda installation and ending with a working setup in editors such as VS Code.

  • Examples collects beginner-oriented walkthroughs and research-oriented reproductions of publications.

  • API Reference documents the public functions that are intended to be imported and used directly.

  • Developer Guide explains how to set up a development environment, build the documentation, expose new functions through the public API, and keep the project quality checks green.