Benchmarks for PyBaMM
- Mentors
- Priyanshu Agarwal, Robert Timms, Valentin Sulzer, Ferran Brosa Planella
- Organization
- NumFOCUS
- Technologies
- python, ci, GitHub Actions, ASV
- Topics
- benchmarking
This project aims to improve and populate the existing benchmark framework of PyBaMM. This will be achieved by -
1. Adding new benchmarks for prominent battery models (Single Particle Model, Doyle Fuller Newman Model, and Single Particle Model with electrolyte).
2. Adding user and developer documentation for benchmarking suite.
3. Creating new benchmarks for other models and PyBaMM's API.
4. Using files from ASV to visualize benchmarks locally.
5. Making the existing and the added benchmarks reproducible in any given environment.
Deliverables -
1. Documentation for benchmarks in PyBaMM’s website
2. Template-like structure for benchmarking battery models available in PyBaMM.
3. Benchmarks for prominent models.
4. Benchmarks for other models and PyBaMM's API.
5. Scripts for automating and running benchmarks locally (stretch).
6. An environment in which all PyBaMM benchmarks can be reproduced (stretch).