OSL Dynamics Toolbox
====================

This package contains models for analysing neuroimaging data. In particular, this package contains methods (based on generative models) for studying dynamics in time series data. This package can be used for:

* Inferring and visualising dynamic (and static) functional networks.
* Spectral estimation: including multitaper spectra and wavelet transforms.
* Burst detection.
* Statistical significant testing (using GLM permutation testing).
* Simulating time series data (e.g. HMMs, autoregressive models, etc).
* And much more!

Models included:

* :doc:`Hidden Markov Model (HMM) <models/hmm>`.
* :doc:`Dynamic Network Modes (DyNeMo) <models/dynemo>`.

For more information on how to use osl-dynamics see the :doc:`documentation <documentation>`.

This package was developed by the Oxford Centre for Human Brain Activity (OHBA) Methods Group at the University of Oxford. Our group website is `here <https://www.psych.ox.ac.uk/research/ohba-analysis-group>`_.

If you find this toolbox useful, please cite:

    **Gohil C., Huang R., Roberts E., van Es M.W.J., Quinn A.J., Vidaurre D., Woolrich M.W. (2023) osl-dynamics: A toolbox for modelling fast dynamic brain activity. eLife 12:RP91949 https://doi.org/10.7554/eLife.91949.2**

If you would like to request new features or if you're confident that you have found a bug, please create a new issue on the `GitHub issues <https://github.com/OHBA-analysis/osl-dynamics/issues>`_ page.

.. |logo1| image:: https://avatars.githubusercontent.com/u/15248840?s=200&v=4
    :width: 125px
    :target: https://www.win.ox.ac.uk/research/our-locations/OHBA

.. |logo2| image:: https://www.win.ox.ac.uk/images/site-logos/integrative-neuroimaging-rgb
    :width: 200px
    :target: https://www.win.ox.ac.uk/

.. |logo3| image:: https://www.win.ox.ac.uk/images/site-logos/ox-logo
    :width: 90px
    :target: http://www.ox.ac.uk/

|logo1| |logo2| |logo3|

-----------------------

Contents
========

.. toctree::
   :maxdepth: 2

   Install <install>
   Documentation <documentation>
   FAQ <faq>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`