Skip to content

Latest commit

 

History

History

NMC

README.md

About:Energy 12.5 Ah NMC111|Graphite Pouch Cell Parameterisation for Battery Parameter eXchange (BPX)

About:Energy Limited, UK: https://www.aboutenergy.io

This folder contains parameters and validation simulations for a Doyle-Fuller-Newman (DFN) model of a 12.5 Ah NMC111|graphite pouch cell. The parameters are supplied by About:Energy to support the new open standard Battery Parameter eXchange (BPX), an outcome of the Faraday Institution Multi-scale Modelling project.

About:Energy develops battery parameter sets for physics-based models by combining information from cycling data with electrochemical and physical measurements on electrodes harvested by cell teardown. For these cells, electrolyte, separator and thermal properties are informed from literature. Advanced datasheets and physics-based models for a wider range of commercially available cells will be made available as an About:Energy product in 2023.

The notebook validation-plots shows comparisons between simulations of the parameterised DFN model and experimental data.
example-simulate-experiment demonstrates how to use the parameterised model to run your own simulations.
parameter_plot plots the functional parameters, and converts appropriate parameters from PyBaMM to BPX format.

The simulations use the package PyBaMM (Python Battery Mathematical Modelling), with the parameters are imported directly from the BPX JSON file using the method:

pybamm.ParameterValues.create_from_bpx("XXX")

🚀 Installation

In order to run the notebooks in this repository, you will need to install PyBaMM (version 22.12 or newer). 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, replacing "XXX" with the repository name:

  1. Clone the repository
https://github.com/About-Energy-OpenSource/XXX.git
  1. Change into the XXX directory
cd XXX
  1. Create a virtual environment
virtualenv env
  1. Activate the virtual environment
source env/bin/activate
  1. Install the required packages
pip install -r requirements.txt

Windows

To install the requirements on Windows use the following terminal commands, replacing "XXX" with the repository name:

  1. Clone the repository
https://github.com/About-Energy-OpenSource/XXX.git
  1. Change into the XXX directory
cd XXX
  1. Create a virtual environment
virtualenv env
  1. 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).

  1. 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: Try pip install wheel before pip install -r requirements.txt.

📫 Get in touch

If you have any questions or would like more information on battery parameterisation services, please get in touch via email: contact@aboutenergy.co.uk.