project description changes

fernandezfran · Dec 28, 2023 · e2ee5af · e2ee5af
1 parent a52b86c
commit e2ee5af
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Bug fixes
 
 - Create the `base` module with the `MapSpline` class.
+- Change the project description.
 
 
 ## v0.2.2 (2023-12-27)

diff --git a/README.md b/README.md
@@ -7,9 +7,8 @@
 [![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 package with a physics-based heuristic model to 
-predict the optimal electrode particle size for a fast-charging of lithium-ion
-batteries.
+**galpynostatic** is a Python package with physics-based models to predict 
+optimal conditions for fast-charging lithium-ion batteries.
 
 
 ## Requirements

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -32,9 +32,8 @@ galpynostatic
    :alt: doi
 
 
-**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
-batteries.
+**galpynostatic** is a Python package with physics-based models to predict
+optimal conditions for fast-charging lithium-ion batteries
 
 
 Requirements

diff --git a/galpynostatic/__init__.py b/galpynostatic/__init__.py
@@ -11,8 +11,8 @@
 # DOCS
 # =============================================================================
 
-"""A physics-based heuristic model to predict the optimal electrode particle \
-size for a fast-charging of lithium-ion batteries."""
+"""A Python package with physics-based models to predict optimal conditions \
+for fast-charging lithium-ion batteries."""
 
 # =============================================================================
 # IMPORTS

diff --git a/pyproject.toml b/pyproject.toml
@@ -12,7 +12,7 @@ version = "0.2.3"
 authors = [{name = "Francisco Fernandez", email = "ffernandev@gmail.com"}]
 readme = "README.md"
 license = {file = "LICENSE"}
-description = "A physics-based heuristic model to predict the optimal electrode particle size for a fast-charging of lithium-ion batteries."
+description = "A Python package with physics-based models to predict optimal conditions for fast-charging lithium-ion batteries."
 keywords = [
     "battery",
     "physics-based",