#################################################
Ionworks Battery Parameter Pipeline documentation
#################################################

Ionworks Battery Parameter Pipeline (`ionworkspipeline`) provides a workflow for parameterizing `PyBaMM <https://www.pybamm.org>`_ 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.

.. code-block:: bash

    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.

.. card:: Common workflows
    :link: source/examples/common_workflows/index
    :link-type: doc
    :link-alt: Common workflows

    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.

.. card:: Basic examples
    :link: source/examples/basic_examples/index
    :link-type: doc
    :link-alt: Basic examples

    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.

.. card:: Advanced examples
    :link: source/examples/advanced_examples/index
    :link-type: doc
    :link-alt: Advanced examples

    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.

.. card:: User guide
    :link: source/user_guide/index
    :link-type: doc
    :link-alt: User guide

    This guide is an overview of the `ionworkspipeline` package and explains the important features and motivation for various design choices.

.. card:: API documentation
    :link: source/api/index
    :link-type: doc
    :link-alt: API documentation

    Get detailed information about the functions, modules, and objects included in `ionworkspipeline`.



.. toctree::
    :hidden:
    :maxdepth: 2

    User Guide <source/user_guide/index>
    source/examples/index
    source/api/index