Giter VIP home page Giter VIP logo

pyecn's Introduction

PyECN

PyECN is a python-based equivalent circuit network (ECN) framework for modelling lithium-ion batteries.

Using PyECN

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

Installing PyECN

Linux/macOS
  1. Clone the repository and enter the directory:
git clone https://github.com/ImperialCollegeLondon/PyECN.git
cd PyECN
  1. Create and activate a virtual environment:
python -m venv .venv
source .venv/bin/activate
  1. Install the dependencies:
pip install -U pip
pip install -r requirements.txt
Windows
  1. Clone the repository and enter the directory:
git clone https://github.com/ImperialCollegeLondon/PyECN.git
cd PyECN
  1. Create and activate a virtual environment:
python -m venv .venv
.venv\Scripts\activate.bat
  1. Install the dependencies:
pip install -U pip
pip install -r requirements.txt

Citing PyECN

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}
}

Contributing to PyECN

TBC

License

PyECN is fully open source. For more information about its license, see LICENSE.

Contributors

  • 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;

pyecn's People

Contributors

dc2917 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.