Metadata-Version: 2.2
Name: beep
Version: 2025.1.29.19
Summary: beep is a python package supporting Battery Estimation and Early Prediction of battery cycle life.
Home-page: https://github.com/TRI-AMDD/beep
Author: Energy and Materials - Toyota Research Institute
Maintainer: Energy and Materials - Toyota Research Institute
License: Apache
Keywords: materials,battery,chemistry,science,electrochemistry,energy,AI,artificial intelligence
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy==1.24.4
Requires-Dist: monty[yaml]==2023.9.25
Requires-Dist: scipy==1.11.1
Requires-Dist: scikit-learn==1.3.2
Requires-Dist: pandas==2.0.3
Requires-Dist: tqdm==4.66.5
Requires-Dist: boto3==1.34.157
Requires-Dist: botocore==1.34.157
Requires-Dist: pytz==2024.1
Requires-Dist: watchtower==3.2.0
Requires-Dist: msgpack-python==0.5.6
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: ruamel.yaml==0.18.6
Requires-Dist: xmltodict==0.13.0
Requires-Dist: pydash==8.0.3
Requires-Dist: lmfit==1.3.2
Requires-Dist: click==8.1.7
Requires-Dist: matplotlib==3.7.5
Requires-Dist: h5py==3.11.0
Provides-Extra: tests
Requires-Dist: pytest-cov==5.0.0; extra == "tests"
Requires-Dist: coveralls==4.0.1; extra == "tests"
Requires-Dist: memory_profiler==0.61.0; extra == "tests"
Requires-Dist: requests; extra == "tests"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: maintainer
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

# Battery Evaluation and Early Prediction (BEEP)

<h4 align="center">
  
![Testing - main](https://github.com/TRI-AMDD/beep/workflows/Testing%20-%20main/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/TRI-AMDD/beep/badge.svg?branch=master)](https://coveralls.io/github/TRI-AMDD/beep?branch=master)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/TRI-AMDD/beep?label=Repo+Size)](https://github.com/TRI-AMDD/beep/graphs/contributors)

</h4>
  
BEEP is a set of tools designed to support Battery Evaluation and Early Prediction of cycle life corresponding to the research of the [d3batt program](https://d3batt.mit.edu/) and the [Toyota Research Institute](http://www.tri.global/accelerated-materials-design-and-discovery/).

* **Documentation:** https://tri-amdd.github.io/beep
* **Source code:** https://github.com/tri-amdd/beep
* **PyPi release:** https://pypi.org/project/beep/

#### How to cite
If you use BEEP, please cite this article:

> P. Herring, C. Balaji Gopal, M. Aykol, J.H. Montoya, A. Anapolsky, P.M. Attia, W. Gent, J.S. Hummelshøj, L. Hung, H.-K. Kwon, P. Moore, D. Schweigert, K.A. Severson, S. Suram, Z. Yang, R.D. Braatz, B.D. Storey, SoftwareX 11 (2020) 100506.
[https://doi.org/10.1016/j.softx.2020.100506](https://doi.org/10.1016/j.softx.2020.100506)

