.. automatic-spike-detection documentation master file, created by
   sphinx-quickstart on Tue Jan 30 10:49:17 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to automatic-spike-detection's documentation!
=====================================================

The automatic-spike-detection package is a Python library for automatically detection interictal epileptiform discharges (IEDs)
in intracranial EEG recordings. We highly recommend to first read the :ref:`Documentation <documentation>` to get
an understanding of the underlying concepts of the algorithm and the terminologies used in the package.

.. grid:: 3

   .. grid-item-card::

        Documentation
        ^^^^^^^^^^^^^

        The documentation provides crucial information about the underlying concepts of the employed detection algorithm.

        +++

        .. button-ref:: documentation
            :expand:
            :color: secondary
            :click-parent:

            To the documentation

   .. grid-item-card::

        Usage
        ^^^^^^^

        This section gives instructions on the installation and usage of the package.

        +++

        .. button-ref:: usage
            :expand:
            :color: secondary
            :click-parent:

            Installation and usage


   .. grid-item-card::

        API Reference
        ^^^^^^^^^^^^^

        The API Reference provides in-depth information on the functionalities of the API.

        +++

        .. button-ref:: reference
            :expand:
            :color: secondary
            :click-parent:

            To the API Reference

.. toctree::
   :maxdepth: 3
   :hidden:
   :titlesonly:

   Documentation <documentation/index>
   Usage <usage/index>
   API Reference <reference/index>

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

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