galpynostatic

:zap::battery: A Python/C++ package with physics-based and data-driven models to predict optimal conditions for fast-charging lithium-ion batteries

https://github.com/fernandezfran/galpynostatic

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary

Keywords

battery data-driven fast-charging heuristic-algorithm metrics physics-based predictions regression-models
Last synced: 4 months ago · JSON representation ·

Repository

:zap::battery: A Python/C++ package with physics-based and data-driven models to predict optimal conditions for fast-charging lithium-ion batteries

Basic Info
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 3
  • Open Issues: 0
  • Releases: 27
Topics
battery data-driven fast-charging heuristic-algorithm metrics physics-based predictions regression-models
Created about 3 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Citation

README.md

galpynostatic

galpynostatics CI documentation status pypi version python version mit license doi

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, NumPy, pandas, scikit-learn and SciPy), are installed automatically.

Installation

You can install the latest stable release of galpynostatic with pip

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 and then read the API.

License

galpynostatic is licensed under the MIT 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 file.

Owner

  • Name: Francisco Fernandez
  • Login: fernandezfran
  • Kind: user
  • Location: Córdoba, Argentina
  • Company: FAMAF, UNC

Computational Physicist

Citation (CITATIONS.bib)

% main galpynostatic citation
@article{fernandez2023towards,
  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}
}

% theoretical framework and universal map data (galpynostatic.datasets)
@article{gavilan2023galvanostatic,
  title={Galvanostatic Fast Charging of Alkali-Ion Battery Materials at the Single-Particle Level: A Map-Driven Diagnosis},
  author={Gavil{\'a}n-Arriazu, E Maximiliano and Barraco, Daniel E and Ein-Eli, Yair and Leiva, Ezequiel PM},
  journal={ChemPhysChem},
  volume={24},
  number={6},
  pages={e202200665},
  year={2023},
  publisher={Wiley Online Library}
}

GitHub Events

Total
  • Release event: 7
  • Watch event: 4
  • Push event: 8
  • Fork event: 1
  • Create event: 7
Last Year
  • Release event: 7
  • Watch event: 4
  • Push event: 8
  • Fork event: 1
  • Create event: 7

Committers

Last synced: 4 months ago

All Time
  • Total Commits: 398
  • Total Committers: 4
  • Avg Commits per committer: 99.5
  • Development Distribution Score (DDS): 0.161
Past Year
  • Commits: 23
  • Committers: 2
  • Avg Commits per committer: 11.5
  • Development Distribution Score (DDS): 0.087
Top Committers
Name Email Commits
fernandezfran f****5@g****m 334
aruderman c****2@g****m 59
Maximiliano Gavilán 9****n 3
maxigavilan m****n@h****m 2

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 39 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 27
  • Total maintainers: 1
pypi.org: galpynostatic

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

  • Documentation: https://galpynostatic.readthedocs.io/
  • 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.
  • Latest release: 0.5.13
    published 11 months ago
  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 39 Last month
Rankings
Dependent packages count: 7.5%
Downloads: 15.3%
Stargazers count: 28.1%
Average: 30.2%
Forks count: 30.2%
Dependent repos count: 69.7%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/CD.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/CI.yml actions
  • actions/checkout master composite
  • actions/setup-python v2 composite
docs/requirements.txt pypi
  • Sphinx *
  • ipykernel *
  • ipython >=8.8.0
  • nbsphinx *
  • sphinx-rtd-theme *
pyproject.toml pypi
  • importlib_metadata *
  • matplotlib *
  • numpy *
  • pandas *
  • scikit-learn *
  • scipy *
requirements_dev.txt pypi
  • check-manifest * development
  • coverage * development
  • flake8 * development
  • flake8-black * development
  • flake8-builtins * development
  • flake8-import-order * development
  • ipdb * development
  • pydocstyle * development
  • pytest * development
  • pytest-cov * development
  • toml * development
  • tomli * development
  • tox * development