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

One page per module of the ``hetero`` package, in the order a run touches
them. All of them are reachable from :func:`hetero.cli.main`, which is
documented separately in :doc:`cli`.

=========================  =====================================================
Page                       Role
=========================  =====================================================
:doc:`api/config`          Every default value the CLI and the simulation share.
:doc:`api/sim`             ``Simulation``, the orchestrator of a whole run.
:doc:`api/stimulus`        Input synthesis, its generators, and their references.
:doc:`api/tasks`           The ``Taylor`` / ``Nostradamus`` / ``Tayloramus`` tasks.
:doc:`api/networks`        Sparse topology and weight sampling.
:doc:`api/dynamics`        The dynamical rules: interface, rate, spiking.
:doc:`api/fitting`         The linear readout and its scores.
:doc:`api/dataloader`      Reading simulated states back from disk.
:doc:`api/utils`           Persistence, complexity measures, tau sampling.
:doc:`api/viz`             Every figure of a run.
=========================  =====================================================

.. toctree::
   :maxdepth: 1

   api/config
   api/sim
   api/stimulus
   api/tasks
   api/networks
   api/dynamics
   api/fitting
   api/dataloader
   api/utils
   api/viz