Bciflow documentation
=====================

Bciflow is a Python package focused on `Brain-Computer Interface (BCI)`_-related work. 
It provides tools for loading pre-established datasets, performing analysis, 
pre-processing, filtering, feature extraction, and classification, 
covering the entire process of creating BCI models. 

.. _Brain-Computer Interface (BCI): https://en.wikipedia.org/wiki/Brain%E2%80%93computer_interface

.. toctree::
   :maxdepth: 1
   :caption: Project Links

   PyPI <https://pypi.org/project/bciflow/>
   GitHub <https://github.com/Lab-HC/bciflow>
   Issues <https://github.com/Lab-HC/bciflow/issues>

.. toctree::
   :maxdepth: 3
   :caption: Package

   source/installation
   source/bciflow.datasets
   source/bciflow.modules

.. toctree::
   :maxdepth: 1
   :caption: Usage

   source/data_files
   source/examples

.. toctree::
   :maxdepth: 1
   :caption: Tutorial

   source/exploring_cbcic
   source/data_processing
   source/customCompsKfold
   source/ownDataset

.. toctree::
   :maxdepth: 1
   :caption: Additional Links

   source/download_datasets


.. toctree
   :maxdepth: 2
   :caption: Additional Links
   :hidden:

   Sphinx Documentation <https://www.sphinx-doc.org/en/master/>
   RTD Theme Documentation <https://sphinx-rtd-theme.readthedocs.io/>
..