.. title:: Home

.. define new line for html
.. |br| raw:: html

   <br />

=======
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).

If you use this toolbox in your work, please include the following citation:|br|
Binns, T. S., & Merk, T. (2023). PyPARRM (Version 1.1.0). DOI:
`10.5281/zenodo.8360751 <https://doi.org/10.5281/zenodo.8360751>`_

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

   installation
   examples
   api
   development