diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a0b1a6..280009e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog of galpynostatic +# v0.1.1 (2023-09-25) + +## Bug fixes + +- Fix citation link, BibTeX and doi. + + # v0.1.0 (2023-07-27) This is the first Python object-oriented version of galpynostatic. diff --git a/CITATION.bib b/CITATION.bib index eca5b2d..bf65fcb 100644 --- a/CITATION.bib +++ b/CITATION.bib @@ -1,12 +1,9 @@ @article{fernandez2023towards, - title = {Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, - journal = {Electrochimica Acta}, - pages = {142951}, - year = {2023}, - issn = {0013-4686}, - doi = {https://doi.org/10.1016/j.electacta.2023.142951}, - url = {https://www.sciencedirect.com/science/article/pii/S001346862301126X}, - author = {F. Fernandez and E.M. Gavilán-Arriazu and D.E. Barraco and A. Visintin and Y. Ein-Eli and E.P.M. Leiva}, - keywords = {Fast-charging, Lithium-Ion Battery, Heuristic Model, Galvanostatic charge}, - abstract = {Fast charging is one of the most important features to be accomplished for the improvement of electric vehicles. In the search for optimal use of active materials for this aim, we present a recipe to find the conditions for fast charging, fifteen minutes for 80 % of the State-of-Charge, of lithium-ion battery's single particle electrodes, thus taking advantage of the maximum possible capacity. A guide based on a general model that considers diffusion and charge transfer limitations under constant current is proposed. This guide was constructed on the basis of our previous theoretical development. A Python free and user-friendly package is provided to handle all experimental data processing and estimations.} + title={Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, + author={Fernandez, F and Gavil{\'a}n-Arriazu, EM and Barraco, DE and Visintin, A and Ein-Eli, Y and Leiva, EPM}, + journal={Electrochimica Acta}, + volume={464}, + pages={142951}, + year={2023}, + publisher={Elsevier} } diff --git a/README.md b/README.md index 52f3145..a180f51 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![pypi version](https://img.shields.io/pypi/v/galpynostatic)](https://pypi.org/project/galpynostatic/) [![python version](https://img.shields.io/badge/python-3.8%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://authors.elsevier.com/c/1hVzk_JcNFx-6) +[![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 package with a physics-based heuristic model to predict the optimal electrode particle size for a fast-charging of lithium-ion @@ -54,27 +54,24 @@ galpynostatic is under If you use galpynostatic in a scientific publication, we would appreciate it if you could cite the following -[article](https://authors.elsevier.com/c/1hVzk_JcNFx-6) +[article](https://doi.org/10.1016/j.electacta.2023.142951) -> F. Fernandez, E. M. Gavilán-Arriazu, D. E. Barraco, A. Visintin, Y. Ein-Eli, +> 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" (2023). _Electrochimica -> Acta_ +> heuristic model based on galvanostatic simulations." _Electrochimica Acta 464_ +> (2023): 142951. BibTeX entry: ```bibtex @article{fernandez2023towards, - title = {Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, - journal = {Electrochimica Acta}, - pages = {142951}, - year = {2023}, - issn = {0013-4686}, - doi = {https://doi.org/10.1016/j.electacta.2023.142951}, - url = {https://www.sciencedirect.com/science/article/pii/S001346862301126X}, - author = {F. Fernandez and E.M. Gavilán-Arriazu and D.E. Barraco and A. Visintin and Y. Ein-Eli and E.P.M. Leiva}, - keywords = {Fast-charging, Lithium-Ion Battery, Heuristic Model, Galvanostatic charge}, - abstract = {Fast charging is one of the most important features to be accomplished for the improvement of electric vehicles. In the search for optimal use of active materials for this aim, we present a recipe to find the conditions for fast charging, fifteen minutes for 80 % of the State-of-Charge, of lithium-ion battery's single particle electrodes, thus taking advantage of the maximum possible capacity. A guide based on a general model that considers diffusion and charge transfer limitations under constant current is proposed. This guide was constructed on the basis of our previous theoretical development. A Python free and user-friendly package is provided to handle all experimental data processing and estimations.} + title={Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, + author={Fernandez, F and Gavil{\'a}n-Arriazu, EM and Barraco, DE and Visintin, A and Ein-Eli, Y and Leiva, EPM}, + journal={Electrochimica Acta}, + volume={464}, + pages={142951}, + year={2023}, + publisher={Elsevier} } ``` diff --git a/docs/source/index.rst b/docs/source/index.rst index 5cd5a3b..fbca9bc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,7 +28,7 @@ galpynostatic :alt: mit license .. image:: https://img.shields.io/badge/doi-10.1016/j.electacta.2023.142951-36abe8 - :target: https://authors.elsevier.com/c/1hVzk_JcNFx-6 + :target: https://doi.org/10.1016/j.electacta.2023.142951 :alt: doi @@ -61,26 +61,23 @@ you could cite the following article: .. pull-quote:: - F. Fernandez, E. M. Gavilán-Arriazu, D. E. Barraco, A. Visintin, Y. Ein-Eli, - E. P. M. Leiva. "Towards a fast-charging of LIBs electrode materials: a - heuristic model based on galvanostatic simulations" (2023). `Electrochimica - Acta`. + 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. BibTeX entry: .. code-block:: bibtex @article{fernandez2023towards, - title = {Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, - journal = {Electrochimica Acta}, - pages = {142951}, - year = {2023}, - issn = {0013-4686}, - doi = {https://doi.org/10.1016/j.electacta.2023.142951}, - url = {https://www.sciencedirect.com/science/article/pii/S001346862301126X}, - author = {F. Fernandez and E.M. Gavilán-Arriazu and D.E. Barraco and A. Visintin and Y. Ein-Eli and E.P.M. Leiva}, - keywords = {Fast-charging, Lithium-Ion Battery, Heuristic Model, Galvanostatic charge}, - abstract = {Fast charging is one of the most important features to be accomplished for the improvement of electric vehicles. In the search for optimal use of active materials for this aim, we present a recipe to find the conditions for fast charging, fifteen minutes for 80 % of the State-of-Charge, of lithium-ion battery's single particle electrodes, thus taking advantage of the maximum possible capacity. A guide based on a general model that considers diffusion and charge transfer limitations under constant current is proposed. This guide was constructed on the basis of our previous theoretical development. A Python free and user-friendly package is provided to handle all experimental data processing and estimations.} + title={Towards a fast-charging of LIBs electrode materials: a heuristic model based on galvanostatic simulations}, + author={Fernandez, F and Gavil{\'a}n-Arriazu, EM and Barraco, DE and Visintin, A and Ein-Eli, Y and Leiva, EPM}, + journal={Electrochimica Acta}, + volume={464}, + pages={142951}, + year={2023}, + publisher={Elsevier} } Contact diff --git a/galpynostatic/datasets/__init__.py b/galpynostatic/datasets/__init__.py index 1cd6bf8..c6db8de 100644 --- a/galpynostatic/datasets/__init__.py +++ b/galpynostatic/datasets/__init__.py @@ -21,9 +21,10 @@ References ---------- -.. [2] Gavilán-Arriazu, E.M., Barraco, D., Ein-Eli, Y. and Leiva, E.P.M., 2022. - Galvanostatic Fast Charging of Alkali‐Ion Battery Materials at the - Single‐Particle Level: A Map‐Driven Diagnosis. `ChemPhysChem`. +.. [2] E. M. Gavilán-Arriazu, D. E. Barraco, D., Y. Ein-Eli and E. P. M. Leiva. + "Galvanostatic Fast Charging of Alkali‐Ion Battery Materials at the + Single‐Particle Level: A Map‐Driven Diagnosis.i" `ChemPhysChem` 24, no. 6 + (2023): e202200665. """ # ============================================================================ diff --git a/galpynostatic/model.py b/galpynostatic/model.py index 360fd99..78be054 100644 --- a/galpynostatic/model.py +++ b/galpynostatic/model.py @@ -111,9 +111,9 @@ class GalvanostaticRegressor(BaseEstimator, RegressorMixin): References ---------- .. [1] F. Fernandez, E. M. Gavilán-Arriazu, D. E. Barraco, A. Visintin, - Y. Ein-Eli, E. P. M. Leiva, 2023. Towards a fast-charging of LIBs + 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`. + simulations." `Electrochimica Acta 464` (2023): 142951. Attributes ---------- diff --git a/pyproject.toml b/pyproject.toml index 4e12bca..69c6a72 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta" [project] name = "galpynostatic" -version = "0.1.0" +version = "0.1.1" authors = [{name = "Francisco Fernandez", email = "ffernandev@gmail.com"}] readme = "README.md" license = {file = "LICENSE"}