🔋 PyBaMM BPX example

An example repository showing how to import parameters defined using the BPX standard. To try out the examples locally on your own machine follow the installation instructions below.

The simplest way to use BPX parameters in PyBaMM is to run a 1C constant-current discharge with a model of your choice with all the default settings and load the BPX JSON file:

import pybamm
model = pybamm.lithium_ion.DFN()  # Doyle-Fuller-Newman model
parameter_values = pybamm.ParameterValues.create_from_bpx("example-params.json")
sim = pybamm.Simulation(model, parameter_values=parameter_values)
sim.solve([0, 3600])  # solve for 1 hour
sim.plot()

💻 About PyBaMM

The example simulations use the package PyBaMM (Python Battery Mathematical Modelling). PyBaMM solves physics-based electrochemical DAE models by using state-of-the-art automatic differentiation and numerical solvers. The Doyle-Fuller-Newman model can be solved in under 0.1 seconds, while the reduced-order Single Particle Model and Single Particle Model with electrolyte can be solved in just a few milliseconds. Additional physics can easily be included such as thermal effects, fast particle diffusion, 3D effects, and more. All models are implemented in a flexible manner, and a wide range of models and parameter sets (NCA, NMC, LiCoO2, ...) are available. There is also functionality to simulate any set of experimental instructions, such as CCCV or GITT, or specify drive cycles.

🚀 Installation

In order to run the examples in this repository you will need to install PyBaMM and BPX. Note that at present the functionality to load in BPX parameters is not included in the latest release of PyBaMM, so for now we must install from a specific branch as specified in requirements.txt. The functionality to load in BPX parameters will be available in PyBaMM 21.12 (released at the end of December 2021).

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:

Clone the repository

git clone https://github.com/pybamm-team/bpx-example

Change into the bpx-example directory

cd bpx-example

Create a virtual environment

virtualenv env

Activate the virtual environment

source env/bin/activate

Install the required packages

pip install -r requirements.txt

Windows

Note: When installing PyBaMM from a specific branch in Windows you may encounter the error unable to create file "...": Filename too long. fatal: unable to checkout working tree. To fix this follow these steps:

Configure Windows to accept long file paths.
Configure git client to accept long paths: git config --global core.longpaths true

Once PyBaMM 21.12 is released we will be able to install in the usual way, rather than from a specific git branch, so this error will be avoided altogether.

To install the requirements on Windows use the following commands:

Clone the repository

git clone https://github.com/pybamm-team/bpx-example

Change into the bpx-example directory

cd bpx-example

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 required packages

pip install -r requirements.txt

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

Troubleshooting

Problem: ModuleNotFoundError: No module named 'wheel'.

Solution: Use the command pip install wheel before installing the requirements.

Problem: error: unable to create file "...": Filename too long. fatal: unable to checkout working tree