.. title:: Home

=======
PyPARRM
=======

A Python signal processing package for identifying and removing stimulation
artefacts from electrophysiological data using the Period-based Artefact
Reconstruction and Removal Method (PARRM) of Dastin-van Rijn *et al.* (2021;
DOI: `10.1016/j.crmeth.2021.100010
<https://doi.org/10.1016/j.crmeth.2021.100010>`_).

All credit for PARRM goes to its original authors. PyPARRM is based on the
original MATLAB implementation of the method
(https://github.com/neuromotion/PARRM).

.. toctree::
   :maxdepth: 3
   :titlesonly:
   :caption: Contents:

   installation
   examples
   api
   development


Credits
-------
**Lead author:** Thomas Samuel Binns | https://github.com/tsbinns

**Contributors:**

*  Timon Merk | https://github.com/timonmerk