WARNING: this package is still under development and significant API changes might take please in the upcoming releases.
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
The recommended way to install pybamm-param is by installing the latest release from PyPI. This can be done running
pip install pbparam
We strongly recommend using virtual environments, see more detailed instructions below (steps 1 and 2).
Another option is to install from source. This is not recommended, unless you want to make edits to the code.
The first step is to install virtualenv
in order to create virtual environments
pip install virtualenv
The module dependencies are listed in pyproject.toml
, the dependancies which are non optional which are installed with the package.
The optional dependancies are split into dev
and docs
. dev
are used for testing and linting, docs
are used for building the sphinx documentation.
-
Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)
virtualenv --python="<path to python 3.11>" env
-
Activate the virtual environment
source env/bin/activate
The virtual environment can later be deactivated (if needed) by running
deactivate
-
Install packages into the virtual envronment
pip install -e ./[dev,docs]
-
Create a virtual environment (this is strongly recommended to avoid clashes with the dependencies)
python -m virtualenv env
-
Activate the virtual environment
env\Scripts\activate.bat
The virtual environment can later be deactivated (if needed) by running
deactivate
-
Install package from Github
pip install -e .\\[dev,docs]
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.