API reference
=============

The API reference is autogenerated from docstrings in the
:mod:`asymmetry` package and covers the public classes and functions
that the GUI is built on top of, organised by subsystem. The user-guide
chapters (:doc:`/reference/index`) explain the *physics* of each
subsystem and the *workflow* that uses it; this reference documents the
exact callable surface.

The entry points for scripted use are: :func:`asymmetry.core.io.load`
for reading any supported raw-data format,
:class:`~asymmetry.core.fitting.engine.FitEngine` with the
:data:`~asymmetry.core.fitting.models.MODELS` registry or a
:class:`~asymmetry.core.fitting.composite.CompositeModel` for
time-domain fits, :func:`~asymmetry.core.fitting.parameter_models.fit_parameter_model`
for parameter-trend fits, and
:func:`~asymmetry.core.project.load_project` /
:func:`~asymmetry.core.project.save_project` for reading and writing
``.asymp`` session files.

.. toctree::
   :maxdepth: 2

   core
   project
   gui
   io
   fitting
   fourier
   transforms
   negmu