```{toctree}
:maxdepth: 3
:hidden:

installation
quickstart
examples/index
api/index
developer
```


# 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](installation.md) 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.
<!-- - [Quickstart](quickstart.md) shows the first checks after installation and points you to the example material. -->
<!-- - [Specifcations]() -->
<!-- - [Project maintenance](project_maintenance.md) -->
<!-- - [Contribution Guide](contribution.md) explains how to contribute new code, examples, and research-driven functionality in a way that is useful for other users and citable in future work. -->
- [Examples](examples/index.md) collects beginner-oriented walkthroughs and research-oriented reproductions of publications.
<!-- - [Publications](index.md) Every publications, which used PyDPEET and the authors send us their code.   -->
- [API Reference](api/index.md) documents the public functions that are intended to be imported and used directly.
- [Developer Guide](developer.md) 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.


<!-- - Logo 
- Was ist PyDPEET
- Links
- Aus readme übernehmen
- Diagramm -->


<!-- ```{toctree}
:maxdepth: 3
:caption: Contents:

installation
quickstart
api/index
examples/notebooks/index
``` -->