.. wearablehrv documentation master file, created by
   sphinx-quickstart on Tue Feb 27 11:56:41 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: https://raw.githubusercontent.com/Aminsinichi/wearable-hrv/master/docs/img/cover.png?raw=true
    :alt: cover

Welcome to the wearablehrv documentation!
=========================================

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
    :alt: License: MIT

.. image:: https://img.shields.io/pypi/v/wearablehrv.svg
    :target: https://pypi.org/project/wearablehrv/
    :alt: Current version at PyPI

.. image:: https://img.shields.io/pypi/pyversions/wearablehrv.svg
    :alt: Supported Python Versions

.. image:: https://img.shields.io/github/last-commit/Aminsinichi/wearable-hrv
    :alt: Last Commit

.. image:: https://mybinder.org/badge_logo.svg
    :target: https://mybinder.org/v2/gh/Aminsinichi/wearable-hrv/master?labpath=docs%2Fexamples%2F
    :alt: Binder

``wearablehrv`` is a Python package that comes in handy if you want to validate wearables and establish their accuracy in terms of heart rate (HR) and heart rate variability (HRV). ``wearablehrv`` is a complete and comprehensive pipeline that helps you go from your recorded raw data through all the necessary pre-processing steps, data analysis, and many visualization tools with graphical user interfaces.

Questions
=========

For any questions regarding the package, please contact:

- `aminsinichi@gmail.com`
- `m.sinichi@vu.nl`

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   overview
   tutorial
   api_individual_pipeline
   api_group_pipeline

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

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