Documentation
=============

Welcome to the osl-ephys documentation!

The :doc:`API reference <autoapi/osl_ephys/index>` provides documentation for the classes, methods and functions in osl-ephys. New users may find the :doc:`FAQ <faq>` useful.


Tutorials
---------

The following tutorials illustrate basic usage and analysis that can be done with osl-ephys.

**Preprocessing**:

- :doc:`tutorials_build/preprocessing_manual`.
- :doc:`tutorials_build/preprocessing_automatic`.
- :doc:`tutorials_build/preprocessing_batch`.


**Source reconstruction**:

- :doc:`tutorials_build/source-recon_coreg`.
- :doc:`tutorials_build/source-recon_deleting-headshape-points`.
- :doc:`tutorials_build/source-recon_subject`.
- :doc:`tutorials_build/source-recon_batch`.


**Statistics (General Linear Modelling)**:

- :doc:`tutorials_build/glm_simulation`.
- :doc:`tutorials_build/glm_sensor`.
- :doc:`tutorials_build/source-recon_batch`.


More examples scripts can be found in the `examples directory <https://github.com/OHBA-analysis/osl-ephys/tree/main/examples>`_ of the repo.

Workshops
---------

- `OHBA Software Library (OSL) workshop <https://osf.io/zxb6c/>`_.