:py:mod:`osl_dynamics`
======================

.. py:module:: osl_dynamics


Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   analysis/index.rst
   config_api/index.rst
   data/index.rst
   files/index.rst
   inference/index.rst
   models/index.rst
   simulation/index.rst
   utils/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   array_ops/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   osl_dynamics.run_pipeline



Attributes
~~~~~~~~~~

.. autoapisummary::

   osl_dynamics.__version__
   osl_dynamics.logger


.. py:function:: run_pipeline(config, output_dir, data=None, extra_funcs=None)

   Run a full pipeline.

   :param config: Path to yaml file, :code:`str` to convert to :code:`dict`,
                  or :code:`dict` containing the config.
   :type config: str or dict
   :param output_dir: Path to output directory.
   :type output_dir: str
   :param data: Data object.
   :type data: osl_dynamics.data.Data, optional
   :param extra_funcs: User-defined functions referenced in the config.
   :type extra_funcs: list of functions, optional


.. py:data:: __version__

   

.. py:data:: logger