Metadata-Version: 2.4
Name: cellpy
Version: 1.1.0.post1
Summary: Extract and manipulate data from battery data testers.
Project-URL: Homepage, https://github.com/jepegit/cellpy
Project-URL: Repository, https://github.com/jepegit/cellpy
Project-URL: Documentation, https://cellpy.readthedocs.io
Author-email: Jan Petter Maehlen <jepe@ife.no>, Asbjoern Ulvestad <Asbjorn.Ulvestad@ife.no>, Muhammad Abdelhamid <Muhammad.Abdelhamid@faam.com>, Meghana Sudarshan <meghana.sudarshan@ife.no>, Julia Wind <julia.wind@ife.no>
License-Expression: MIT
License-File: LICENSE.md
Keywords: battery,cellpy
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.13
Requires-Dist: cellpycore==0.2.1
Requires-Dist: charset-normalizer
Requires-Dist: click
Requires-Dist: cookiecutter
Requires-Dist: dateparser
Requires-Dist: defusedxml
Requires-Dist: fabric
Requires-Dist: ipykernel
Requires-Dist: isal
Requires-Dist: jinja2-time
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas<4,>=3.0.3
Requires-Dist: pint
Requires-Dist: platformdirs>=4.10.0
Requires-Dist: polars
Requires-Dist: pyarrow>=16
Requires-Dist: pydantic-settings>=2.14.2
Requires-Dist: pygithub
Requires-Dist: pyodbc
Requires-Dist: python-box
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: ruamel-yaml
Requires-Dist: scipy
Requires-Dist: setuptools
Requires-Dist: sqlalchemy-access; platform_system == 'Windows'
Requires-Dist: sqlalchemy>=2.0.0
Requires-Dist: tables
Requires-Dist: tqdm
Requires-Dist: typer
Requires-Dist: xmltodict
Provides-Extra: all
Requires-Dist: ipython; extra == 'all'
Requires-Dist: jupyter; extra == 'all'
Requires-Dist: kaleido<1.4,>=0.1; extra == 'all'
Requires-Dist: lmfit; extra == 'all'
Requires-Dist: plotly; extra == 'all'
Requires-Dist: seaborn; extra == 'all'
Provides-Extra: batch
Requires-Dist: ipython; extra == 'batch'
Requires-Dist: jupyter; extra == 'batch'
Requires-Dist: kaleido<1.4,>=0.1; extra == 'batch'
Requires-Dist: plotly; extra == 'batch'
Requires-Dist: seaborn; extra == 'batch'
Provides-Extra: fit
Requires-Dist: lmfit; extra == 'fit'
Description-Content-Type: text/markdown

<img src="https://raw.githubusercontent.com/jepegit/cellpy/master/docs/_static/cellpy-icon-long.svg" height="100" alt="cellpy-icon">

# **cellpy** - *a library for assisting in analysing batteries and cells*


[![cellpy](https://img.shields.io/pypi/v/cellpy.svg)](https://pypi.python.org/pypi/cellpy)
[![cellpy](https://readthedocs.org/projects/cellpy/badge/?version=latest)](https://cellpy.readthedocs.io/en/latest/?badge=latest)
[![cellpy](https://static.pepy.tech/badge/cellpy)](https://pepy.tech/project/cellpy)

This Python Package was developed to help the
researchers at IFE, Norway, in their cumbersome task of
interpreting and handling data from cycling tests of batteries and cells.

## Features

* Convert testing data into a common format
* Summarize and compare data
* Filter out the steps of interest
* Process and plot the data
* Do simple and advanced analysis on single datasets as well as collections of datasets
* And more!

## Documentation

The documentation for ``cellpy`` is hosted on [Read the Docs](https://cellpy.readthedocs.io).

## Installation and dependencies

The easiest way to install ``cellpy`` is to install with conda or pip.

With conda:

```
conda install -c conda-forge cellpy
```

Or if you prefer installing using pip:

```
python -m pip install cellpy
```

Have a look at the documentation for more detailed installation procedures, especially
with respect to "difficult" dependencies when installing with pip.

## License

``cellpy`` is free software made available under the MIT License.

## Citing cellpy

If you use ``cellpy`` in your work, please cite our paper:

> Wind J., Ulvestad A., Abdelhamid M., Mæhlen J.P. (2024). Cellpy – an open-source library for processing and analysis of battery testing data. _Journal of Open Source Software, 9(97), 6236_.

[![DOI](https://joss.theoj.org/papers/10.21105/joss.06236/status.svg)](https://doi.org/10.21105/joss.06236)

## Contributing

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given. If you want to contribute,
please have a look at [Contributing Guidelines](CONTRIBUTING.md).
