Important

This repository is now maintained under the pybamm-team umbrella, and can be found here.

PyBaMM EIS

PyBaMM EIS rapidly calculates the electrochemical impedance of any battery model defined using PyBaMM.

This code was developed as part of the Oxford Mathematics Summer Project "Efficient Linear Algebra Methods to Determine Li-ion Battery Behaviour".

Student: Rishit Dhoot

Supervisors: Prof Colin Please and Dr. Robert Timms

🔋 Using PyBaMM EIS

The easiest way to use PyBaMM EIS is to compute the impedance of a model of your choice with the default parameters:

import pbeis
import pybamm

model = pybamm.lithium_ion.DFN(options={"surface form": "differential"})  # DFN with capacitance
eis_sim = pbeis.EISSimulation(model)
eis_sim.solve(pbeis.logspace(-4, 4, 30))  # calculate impedance at log-spaced frequencieshttps://github.com/pybamm-team/pybamm-eis
eis_sim.nyquist_plot()

💻 About PyBaMM

The example simulations use the package PyBaMM (Python Battery Mathematical Modelling). PyBaMM is an open-source battery simulation package written in Python. Our mission is to accelerate battery modelling research by providing open-source tools for multi-institutional, interdisciplinary collaboration. Broadly, PyBaMM consists of (i) a framework for writing and solving systems of differential equations, (ii) a library of battery models and parameters, and (iii) specialized tools for simulating battery-specific experiments and visualizing the results. Together, these enable flexible model definitions and fast battery simulations, allowing users to explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.

🚀 Installation

In order to run the notebooks in this repository you will need to install the pybamm-eis package. We recommend installing within a virtual environment in order to not alter any python distribution files on your machine.

PyBaMM is available on GNU/Linux, MacOS and Windows. For more detailed instructions on how to install PyBaMM, see the PyBaMM documentation.

Linux/Mac OS

To install the requirements on Linux/Mac OS use the following terminal commands:

1. Clone the repository

git clone https://github.com/rish31415/pybamm-eis

2. Change into the pybamm-eis directory

cd pybamm-eis

3. Create a virtual environment

virtualenv env

4. Activate the virtual environment

source env/bin/activate

5. Install the pbeis package

pip install .

Windows

To install the requirements on Windows use the following commands:

1. Clone the repository

git clone https://github.com/rish31415/pybamm-eis

2. Change into the pybamm-eis directory

cd pybamm-eis

3. Create a virtual environment

python -m virtualenv env

4. Activate the virtual environment

\path\to\env\Scripts\activate

where \path\to\env is the path to the environment created in step 3 (e.g. C:\Users\'Username'\env\Scripts\activate.bat).

5. Install the pbeis package

pip install .

As an alternative, you can set up Windows Subsystem for Linux. This allows you to run a full Linux distribution within Windows.

Developer

To install as a developer follow the instructions above, replacing the final step with

pip install -e .

This will allow you to edit the code locally.

📫 Get in touch

If you have any questions, or would like to know more about the project, please get in touch via email timms@maths.ox.ac.uk.