#####################
``ionworks.pipeline``
#####################

``ionworks.pipeline`` provides Pydantic schemas for declaratively building
configurations for the Ionworks battery parameterization and simulation
stack. Every runtime class in the private ``ionworkspipeline`` engine has a
matching schema here, so you can assemble a pipeline configuration from typed
objects, serialize it to a config dict, and submit it to the Ionworks API
without installing it.

For conceptual / mathematical background, see the `Technical Guide
<https://guide.ionworks.com/>`_.

.. note::

   ``.to_config()`` is the only supported serializer. Pydantic's own
   ``.model_dump()`` is **not** a wire format — it omits the ``type``
   discriminator and emits Python attribute names rather than the wire names
   the API expects (``data_input`` rather than ``data``), so it returns a
   dict the Ionworks API may reject. Always build API payloads with
   ``.to_config()``.

Core classes
============

The top-level entry points for assembling a pipeline configuration:

.. autoclass:: ionworks.pipeline.BaseSchema
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.Pipeline
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.DataFit
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.ArrayDataFit
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.Parameter
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.Library
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.Material
    :members:
    :no-index:

.. autoclass:: ionworks.pipeline.Validation
    :members:
    :no-index:

.. toctree::
    :maxdepth: 2
    :caption: Examples

    examples/index

Submodule reference
===================

.. toctree::
    :maxdepth: 2

    objectives
    calculations
    data_fit
    result
    data_loader
    plots
    direct_entries
    costs
    priors
    stats
    transforms
    parameter
    parameter_estimators
    distribution_samplers
    library
    models
    objective_functions
    validation
    core