pybamm-param: PyBaMM Parameter Optimization Tool

WARNING: this package is still under development.

This package is provides parameter optimization for PyBaMM (Python Battery Mathematical Modelling) using different optimization techniques. Examples on how to run this package can be found in the examples folder

🚀 Installing pybamm-param

These installation instructions assume you have Python installed (versions 3.8 to 3.11) and that you have also installed the virtualenv package which can be done by running

pip install virtualenv

Linux & MacOS

1. Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)

virtualenv env

2. Activate the virtual environment

source env/bin/activate

The virtual environment can later be deactivated (if needed) by running

deactivate

3. Install package from Github

pip install git+https://github.com/paramm-team/pybamm-param

Windows

1. Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)

python -m virtualenv env

2. Activate the virtual environment

env\Scripts\activate.bat

The virtual environment can later be deactivated (if needed) by running

deactivate

3. Install package from Github

pip install git+https://github.com/paramm-team/pybamm-param

🛠️ Contributing to pybamm-param

If you'd like to help us develop pybamm-param by adding new methods, writing documentation, or fixing embarrassing bugs, please have a look at these guidelines first.