Skip to content

Commit

Permalink
Add a battery model reference page to the documentation (#3327)
Browse files Browse the repository at this point in the history
* Adding a new page

* Adding links

* Add review articles

* Rewording the text

* Fixing a typo

* Fix typo

* Switching to doi.org to fix lychee checking

* Remove www in doi URLs for Lychee
  • Loading branch information
kratman authored Sep 21, 2023
1 parent d75d0d5 commit 270c5b0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
29 changes: 29 additions & 0 deletions docs/source/user_guide/fundamentals/battery_models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Battery Models

References for the battery models used in PyBaMM simulations can be found calling
```python
pybamm.print_citations()
```
However, a few papers are provided in this section for anyone interested in reading the theory
behind the models before doing the tutorials.

## Review Articles

[Review of physics-based lithium-ion battery models](https://doi.org/10.1088/2516-1083/ac7d31)

[Review of parameterisation and a novel database for Li-ion battery models](https://doi.org/10.1088/2516-1083/ac692c)

## Model References

### Lithium-Ion Batteries

[Doyle-Fuller-Newman model](https://doi.org/10.1149/1.2221597)

[Single particle model](https://doi.org/10.1149/2.0341915jes)


### Lead-Acid Batteries

[Isothermal porous-electrode model](https://doi.org/10.1149/2.0301910jes)

[Leading-Order Quasi-Static model](https://doi.org/10.1149/2.0441908jes)
2 changes: 1 addition & 1 deletion docs/source/user_guide/fundamentals/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ solution = sim.solve()
solution.plot()
```

Finally, PyBaMM provides cusotm visualization tools:
Finally, PyBaMM provides custom visualization tools:

- [](quick_plot): for easily plotting simulation outputs in a grid, including comparing multiple simulations
- [](pybamm.plot_voltage_components): for plotting the component overpotentials that make up a voltage curve
Expand Down
1 change: 1 addition & 0 deletions docs/source/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ caption: Fundamentals and usage
maxdepth: 2
---
fundamentals/index
fundamentals/battery_models
```

# Example notebooks
Expand Down

0 comments on commit 270c5b0

Please sign in to comment.