Metadata-Version: 2.4
Name: PyDPEET
Version: 0.2.0
Summary: Python package to read, unify, and convert battery measurement data from arbitrary battery cyclers to Parquet files. This package also provides functions to process, evaluate, and visualise the standardised data.
Author: Alexander Günter Hinrichsen, Jan Kalisch, Daniel Schröder, Cataldo De Simone
Author-email: Anton Schlösser <a.schloesser@tu-berlin.de>, Martin Otto <m.otto.1@tu-berlin.de>
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENCE.md
License-File: AUTHORS.md
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: pyarrow
Requires-Dist: python-calamine
Requires-Dist: numba
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: bibtexparser
Requires-Dist: scikit-learn
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: bibtexparser; extra == "docs"
Dynamic: license-file

# PyDPEET - Fast and Easy Battery Data Unification, Processing, and Analysis

[[_TOC_]]

## Disclaimer

This README is still under (re-)construction due to changes in the codebase.

## Description

<!-- This project enables you to convert battery measurement data to a standardized format.

Cycler output their measurement data in different formats and different file types, like for example .csv and .xslx. Each has to be handled differently which makes it difficult to work with the data and that's the reason why we created a standardized format.
The standardized Data and Metadata can be used inside of the code and can be output as a .csv (Data), .xlsx (Data) or parquet(Data) to a output_path of your choosing.

Keeping additional data outside of our definition of the standardized columns and custom cycler handling is also possible. -->


## Standardised Format

The standard columns are defined as follows:

```python
STANDARD_COLUMNS = [
    "Meta_Data",
    "Step_Count",
    "Voltage[V]",
    "Current[A]",
    "Temperature[°C]",
    "Test_Time[s]",
    "Date_Time",
    "EIS_f[Hz]",
    "EIS_Z_Real[Ohm]",
    "EIS_Z_Imag[Ohm]",
    "EIS_DC[A]"
]
```

## Meta data

## Supported Cyclers

## Installation

### For Developers

#### Rebuild package for "pip"

#### How to renew the documentation after implementing new functions

### For Users

## Usage

## Custom Handling of Cycler

## How to add a Custom Handling to the Project
