Skip to content

Commit aead42f

Browse files
committed
update README
1 parent 09efd8a commit aead42f

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
# TEC-reduced-model
2-
Code and data for the paper "Systematic derivation and validation of reduced thermal-electrochemical for Li-ion batteries using asymptotic methods"
1+
# Systematic derivation and validation of reduced thermal-electrochemical for Li-ion batteries using asymptotic methods
2+
Code and data for the paper "Systematic derivation and validation of reduced thermal-electrochemical for Li-ion batteries using asymptotic methods" by Ferran Brosa Planella, Muhammad Sheikh and W. Dhammika Widanage (2020).
3+
4+
# How to cite the code or data?
5+
If you found the code or the data useful please cite our paper
6+
> F. Brosa Planella, M. Sheikh, and W. D. Widanage, Systematic derivation and validation of reduced thermal-electrochemical for Li-ion batteries using asymptotic methods, _Preprint_ (2020).
7+
8+
# How to use the code?
9+
In order to run the code you need to install the developer version of PyBaMM, as the model need is not yet on the released version. To install the developer version follow the instructions [here](https://pybamm.readthedocs.io/en/latest/install/install-from-source.html). Following the PyBaMM recommendations, we strongly recommend to install it in a Python virtual environment, in order not to alter any distribution Python files.
10+
11+
12+

0 commit comments

Comments
 (0)