PyBaMM EIS rapidly calculates the electrochemical impedance of any battery model defined using PyBaMM, see the documentation
The easiest way to use PyBaMM EIS is to compute the impedance of a model of your choice with the default parameters:
import pybammeis
import pybamm
import numpy as np
# DFN with capacitance
model = pybamm.lithium_ion.DFN(options={"surface form": "differential"})
eis_sim = pybammeis.EISSimulation(model)
# calculate impedance at log-spaced frequencies
eis_sim.solve(np.logspace(-4, 4, 30))
eis_sim.nyquist_plot()
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.
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.
To install the requirements on Linux/Mac OS use the following terminal commands:
-
Clone the repository
git clone https://github.com/pybamm-team/pybamm-eis
-
Change into the
pybamm-eis
directorycd pybamm-eis
-
Create a virtual environment
virtualenv env
-
Activate the virtual environment
source env/bin/activate
-
Install the
pybammeis
packagepip install .
To install the requirements on Windows use the following commands:
-
Clone the repository
git clone https://github.com/pybamm-team/pybamm-eis
-
Change into the
pybamm-eis
directorycd pybamm-eis
-
Create a virtual environment
python -m virtualenv env
-
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
). -
Install the
pybammeis
packagepip install .
As an alternative, you can set up Windows Subsystem for Linux. This allows you to run a full Linux distribution within Windows.
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.
API documentation for the pybammeis
package can be built locally using Sphinx. To build the documentation, first change into the docs
directory, and then execute the following command:
make html
This will generate a number of html files in the docs/_build/html
directory. To view the documentation, open the file docs/_build/html/index.html
in a web browser.
If you'd like to help us develop PyBaMM by adding new methods, writing documentation, or fixing embarrassing bugs, please have a look at these guidelines first.
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
For any questions, comments, suggestions or bug reports, please see the contact page.
pybamm-eis is fully open source. For more information about its license, see LICENSE.