Ionworks Battery Parameter Pipeline documentation¶
Ionworks Battery Parameter Pipeline (ionworkspipeline) provides a workflow for parameterizing PyBaMM battery models from experimental data. The workflow is designed to be modular and flexible, so that users can easily modify the workflow to suit their needs and available data.
For any questions or feedback, please contact info@ionworks.com.
Quick Start¶
Install ionworkspipeline and run some examples.
Installation¶
To install ionworkspipeline, you require a license.yml file provided by ionworks. The package can be installed using the open-source ionwizard tool.
pip install ionwizard
ionwizard-install -c license.yml .
Ionwizard will store the license information for updating and validating ionworks packages.
Next steps¶
After installation, we recommend the trying the examples. For more information, read the user guide and look at the API documentation.
See some common workflows for parameterizing battery models from experimental data. Includes half-cell OCP fitting, full-cell balancing, and estimating parameters from cycling data.
Try some basic examples to get started with ionworkspipeline. These exampled are not necessarily battery specific, but give an overview of how to use the package.
Try some advanced examples to learn more about how to use ionworkspipeline for specific battery modeling tasks, including experiment-specific workflows such as parameterization from EIS data.
This guide is an overview of the ionworkspipeline package and explains the important features and motivation for various design choices.
Get detailed information about the functions, modules, and objects included in ionworkspipeline.