########
ionworks
########

``ionworks`` is the Python package for the `Ionworks <https://ionworks.com>`_
platform.

.. code-block:: bash

    pip install ionworks

.. code-block:: python

    import ionworks as iw

    client = iw.api.Client()  # reads IONWORKS_API_KEY from the environment

.. list-table::
    :header-rows: 1

    * - Subpackage
      - Contents
    * - :doc:`ionworks.api <api/index>`
      - Client for the Ionworks API
    * - :doc:`ionworks.pipeline <pipeline/index>`
      - Pydantic schemas for building pipeline configurations
    * - :doc:`ionworks.data <data/index>`
      - Reading, transforming and loading battery cycling data
    * - :doc:`ionworks.util <util/index>`
      - Shared utilities

Upgrading from ``ionworks-api``, ``ionworksdata``, ``ionworks-schema`` or ``iwutil``?
See the :doc:`migration guide <migration>`.

.. toctree::
    :hidden:

    api/index
    pipeline/index
    data/index
    util/index
    migration

.. toctree::
    :hidden:
    :caption: Release history

    history/ionworks-api
    history/ionworks-schema
    history/ionworksdata
    history/iwutil