PyECN is a python-based equivalent circuit network (ECN) framework for modelling lithium-ion batteries.
PyECN is run by providing pyecn
with a configuration file for a simulation, containing details of a cell's geometrical, physical, electrical and thermal properties, as well as operating conditions. An example configuration file for a pouch cell is provided in pouch.toml
:
$ python -m pyecn pouch.toml
PyECN can also be run in an interactive python session:
$ python
>>> import pyecn
>>> pyecn.run()
Enter config file name:
pouch.toml
Linux/macOS
- Clone the repository and enter the directory:
git clone https://github.com/ImperialCollegeLondon/PyECN.git
cd PyECN
- Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate
- Install the dependencies:
pip install -U pip
pip install -r requirements.txt
Windows
- Clone the repository and enter the directory:
git clone https://github.com/ImperialCollegeLondon/PyECN.git
cd PyECN
- Create and activate a virtual environment:
python -m venv .venv
.venv\Scripts\activate.bat
- Install the dependencies:
pip install -U pip
pip install -r requirements.txt
If you use PyECN in your work, please cite our paper
Li, S., Rawat, S. K., Zhu, T., Offer, G. J., & Marinescu, M. (2023). Python-based Equivalent Circuit Network (PyECN) Model-ling Framework for Lithium-ion Batteries: Next generation open-source battery modelling framework for Lithium-ion batteries. Engineering Archive.
You can use the BibTeX
@article{lipython,
title={Python-based Equivalent Circuit Network (PyECN) Model-ling Framework for Lithium-ion Batteries: Next generation open-source battery modelling framework for Lithium-ion batteries},
author={Li, Shen and Rawat, Sunil Kumar and Zhu, Tao and Offer, Gregory J and Marinescu, Monica},
publisher={Engineering Archive}
}
TBC
PyECN is fully open source. For more information about its license, see LICENSE.
- Shen Li: Conceptualisation, methodology, creator and lead developer of PyECN, writing and review;
- Sunil Rawat: Contributor of PyECN, discussion, writing and review;
- Tao Zhu: Contributor of PyECN, discussion, writing and review;
- Gregory J Offer: Conceptualisation, funding acquisition, supervision, writing – review & editing;
- Monica Marinescu: Conceptualisation, funding acquisition, supervision, writing – review & editing;