Metadata-Version: 2.1
Name: galpynostatic
Version: 0.5.2
Summary: A Python/C++ package with physics-based and data-driven models to predict optimal conditions for fast-charging lithium-ion batteries.
Author-email: Francisco Fernandez <ffernandev@gmail.com>, Maximiliano Gavilán <maxigavilan@hotmail.com>, Andres Ruderman <andres.ruderman@gmail.com>
License: MIT License
        
        Copyright (c) 2022-2023 Francisco Fernandez
        Copyright (c) 2024 Francisco Fernandez, Maximiliano Gavilán, Andrés Ruderman
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/fernandezfran/galpynostatic
Project-URL: documentation, https://galpynostatic.readthedocs.io
Project-URL: repository, https://github.com/fernandezfran/galpynostatic
Project-URL: changelog, https://github.com/fernandezfran/galpynostatic/blob/main/CHANGELOG.md
Keywords: battery,physics-based,data-driven,heuristic-algorithm,regression-models,fast-charging,predictions,metrics
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib_metadata
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: scikit-learn
Requires-Dist: scipy

# galpynostatic

[![galpynostatics CI](https://github.com/fernandezfran/galpynostatic/actions/workflows/CI.yml/badge.svg)](https://github.com/fernandezfran/galpynostatic/actions/workflows/CI.yml)
[![documentation status](https://readthedocs.org/projects/galpynostatic/badge/?version=latest)](https://galpynostatic.readthedocs.io/en/latest/?badge=latest)
[![pypi version](https://img.shields.io/pypi/v/galpynostatic)](https://pypi.org/project/galpynostatic/)
[![python version](https://img.shields.io/badge/python-3.12%2B-4584b6)](https://www.python.org/)
[![mit license](https://img.shields.io/badge/License-MIT-ffde57)](https://github.com/fernandezfran/galpynostatic/blob/main/LICENSE)
[![doi](https://img.shields.io/badge/doi-10.1016/j.electacta.2023.142951-36abe8)](https://doi.org/10.1016/j.electacta.2023.142951)

**galpynostatic** is a Python/C++ package with physics-based and data-driven 
models to predict optimal conditions for fast-charging lithium-ion batteries.


## Contact

If you have any questions, you can contact me at <ffernandev@gmail.com>


## Requirements

You need Python 3.12+ to run galpynostatic. All other dependencies, which are the 
usual ones of the scientific computing stack
([matplotlib](https://matplotlib.org/), [NumPy](https://numpy.org/), 
[pandas](https://pandas.pydata.org/), [scikit-learn](https://scikit-learn.org/) 
and [SciPy](https://scipy.org/)), are installed automatically.


## Installation

You can install the latest stable release of galpynostatic with 
[pip](https://pip.pypa.io/en/latest/)

```
python -m pip install --upgrade pip
python -m pip install --upgrade galpynostatic
```


## Usage

To learn how to use galpynostatic you can start by following the 
[tutorials](https://galpynostatic.readthedocs.io/en/latest/tutorials/index.html)
and then read the 
[API](https://galpynostatic.readthedocs.io/en/latest/api/index.html).


## License

galpynostatic is licensed under the 
[MIT License](https://github.com/fernandezfran/galpynostatic/blob/main/LICENSE).


## Citations

If you use galpynostatic in a scientific publication, we would appreciate it if 
you could cite the main article of the package:

> F. Fernandez, E. M. Gavilán-Arriazu, D. E. Barraco, A. Visintin, Y. Ein-Eli and 
> E. P. M. Leiva. "Towards a fast-charging of LIBs electrode materials: a 
> heuristic model based on galvanostatic simulations." _Electrochimica Acta 464_
> (2023): 142951. DOI: https://doi.org/10.1016/j.electacta.2023.142951

For certain modules of the code, please refer to other works:
- `galpynostatic.metric`: TODO DOI
- `galpynostatic.datasets`: https://doi.org/10.1002/cphc.202200665

BibTeX entries can be found in the 
[CITATIONS.bib](https://github.com/fernandezfran/galpynostatic/blob/main/CITATIONS.bib)
file.
