Welcome to vital_sqi's documentation!
=====================================

.. image:: ./_static/imgs/logo.png
   :alt: Vital_SQI logo

.. note::
   Vital_SQI is a Python library designed for analyzing physiological signals (like ECG and PPG) and computing Signal Quality Indices (SQI).


The code of the project is on `GitHub <https://github.com/Oucru-Innovations/vital-sqi>`_.

Getting Started
---------------
.. toctree::
   :maxdepth: 2

   usage/installation
   usage/introduction
   usage/contributions
   usage/development
   usage/quickstart

Data Manipulation
-----------------
.. toctree::
   :maxdepth: 2

   _examples/notebooks/Data_manipulation_ECG_PPG

Pipeline
--------
.. toctree::
   :maxdepth: 2

   _examples/notebooks/SQI_pipeline

Documentation
-------------
.. toctree::
   :maxdepth: 2

   docstring/modules
   docstring/vital_sqi.pipeline
   docstring/vital_sqi.sqi

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

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