Supercapacitor models

Warning

This repository is still under development and is not yet ready for use.

This repository contains supercapacitor models implemented in PyBaMM, mostly based on the article:

M.W. Verbrugge, P. Liu, Microstructural Analysis and Mathematical Modeling of Electric Double-Layer Supercapacitors, J. Electrochem. Soc. 152 (2005) D79. https://doi.org/10.1149/1.1878052.

🚀 Installing the package

The package is not yet available on PyPI so it needs to be installed from the source code. These instructions assume that you have a compatible Python version installed (between 3.9 and 3.12).

Linux and macOS

First clone the repository, either from the command line or using a Git client:

git clone git@github.com:mmsg-warwick/supercapacitors.git

If you do not have nox installed, install it with

python3 -m pip install nox

Then, navigate to the repository you just cloned and run

nox -s dev

This will create a virtual environment called venv in your current directory and install the package in editable mode with all the development dependencies. To activate the virtual environment, run

source env/bin/activate

You can now run the examples in the examples directory.

If needed, you can deactivate your virtual environment with

deactivate

Windows

First clone the repository, either from the command line or using a Git client:

git clone git@github.com:mmsg-warwick/supercapacitors.git

If you do not have nox installed, install it with

python3 -m pip install nox

Then, navigate to the repository you just cloned and run

nox -s dev

This will create a virtual environment called venv in your current directory and install the package in editable mode with all the development dependencies. To activate the virtual environment, run

venv\Scripts\activate.bat

if you are using Command Prompt, or

venv\Scripts\Activate.ps1

if you are using PowerShell.

You can now run the examples in the examples directory.

If needed, you can deactivate your virtual environment with

deactivate