######################
Ionworks Schema API
######################

``ionworks_schema`` provides Pydantic schemas for declaratively building
configurations for the `ionworkspipeline
<https://packages.docs.ionworks.com/ionworkspipeline/>`_ battery
parameterization and simulation stack. Every runtime class in the pipeline
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 the pipeline runtime itself.

For conceptual / mathematical background, see the `Technical Guide
<https://guide.ionworks.com/>`_. For runtime implementations of the same
classes, see the `ionworkspipeline API
<https://packages.docs.ionworks.com/ionworkspipeline/>`_.

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

The top-level entry points mirror ``ionworkspipeline``'s top-level API.

.. autoclass:: ionworks_schema.BaseSchema
    :members:

.. autoclass:: ionworks_schema.Pipeline
    :members:
    :no-index:

.. autoclass:: ionworks_schema.DataFit
    :members:
    :no-index:

.. autoclass:: ionworks_schema.ArrayDataFit
    :members:
    :no-index:

.. autoclass:: ionworks_schema.Parameter
    :members:
    :no-index:

.. autoclass:: ionworks_schema.Library
    :members:
    :no-index:

.. autoclass:: ionworks_schema.Material
    :members:
    :no-index:

.. autoclass:: ionworks_schema.Validation
    :members:
    :no-index:

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

.. toctree::
    :maxdepth: 2

    source/api/objectives
    source/api/calculations
    source/api/data_fit
    source/api/direct_entries
    source/api/costs
    source/api/priors
    source/api/stats
    source/api/transforms
    source/api/parameter
    source/api/parameter_estimators
    source/api/distribution_samplers
    source/api/library
    source/api/models
    source/api/objective_functions
    source/api/validation
    source/api/core