.. pepbench documentation master file

pepbench Documentation Overview
===============================

Welcome to the documentation of **pepbench** – your Python framework for the automated extraction of the
pre-ejection period (PEP) from electrocardiogram (ECG) and impedance cardiography (ICG) signals.

This documentation will help you to get up to speed quickly. Take a look at the :ref:`User Guide<user-guide>`, and the
:ref:`Example Gallery<examples_gallery>` sections for a guide on how to use **pepbench**.

.. toctree::
   :maxdepth: 1
   :caption: Content:

   Getting Started <README.md>
   guides/index.rst
   examples/index.rst
   modules/index.rst
   Contributing <source/contributing/CONTRIBUTING.md>
   Changelog <CHANGELOG.md>
   About <source/about/index.rst>

Indices and Tables
==================

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