Skip to main content

A Python implementation of the preprocessing pipeline (PREP) for EEG data.

Project description

Python build Python tests codecov Documentation Status PyPI version Conda version Zenodo archive

pyprep

For documentation, see the:

pyprep is a Python implementation of the Preprocessing Pipeline (PREP) for EEG data, working with MNE-Python.

ALPHA SOFTWARE. This package is currently in its early stages of iteration. It may change both its internals or its user-facing API in the near future. Any feedback and ideas on how to improve either of these is welcome! Use this software at your own risk.

Installation

pyprep requires Python version 3.8 or higher to run properly. We recommend to run pyprep in a dedicated virtual environment (for example using conda).

For installing the stable version of pyprep, call:

pip install pyprep

or, as an alternative to pip, call:

conda install -c conda-forge pyprep

For installing the latest (development) version of pyprep, call:

pip install git+https://github.com/sappelhoff/pyprep.git@main

Both the stable and the latest installation will additionally install all required dependencies automatically. The dependencies are defined in the setup.cfg file under the options.install_requires section.

Contributions

We are actively looking for contributors!

Please chime in with your ideas on how to improve this software by opening a GitHub issue, or submitting a pull request.

See also our CONTRIBUTING.md file for help with submitting a pull request.

Potential contributors should install pyprep in the following way:

  1. First they should fork pyprep to their own GitHub account.

  2. Then they should run the following commands, adequately replacing <gh-username> with their GitHub username.

git clone https://github.com/<gh-username>/pyprep
cd pyprep
pip install -r requirements-dev.txt
pre-commit install
pip install -e .

Citing

If you use this software in academic work, please cite it using the Zenodo entry. Please also consider citing the original publication on PREP (see “References” below). Metadata is encoded in the CITATION.cff file.

References

  1. Bigdely-Shamlo, N., Mullen, T., Kothe, C., Su, K.-M., & Robbins, K. A. (2015). The PREP pipeline: standardized preprocessing for large-scale EEG analysis. Frontiers in Neuroinformatics, 9, 16. doi: 10.3389/fninf.2015.00016

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyprep-0.4.3.tar.gz (20.1 MB view details)

Uploaded Source

Built Distribution

pyprep-0.4.3-py2.py3-none-any.whl (34.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pyprep-0.4.3.tar.gz.

File metadata

  • Download URL: pyprep-0.4.3.tar.gz
  • Upload date:
  • Size: 20.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pyprep-0.4.3.tar.gz
Algorithm Hash digest
SHA256 4e7713f214bdcbb23f1c1f1eb20602e13731961bd33d1b5fc78a1c38d02fbac0
MD5 b8fe0364bfd1e9641173b186d9238c6a
BLAKE2b-256 668e5342bf5b5b0b23b0c2f9188bc8491a755dd7283fd015bd20e51db60c8e02

See more details on using hashes here.

File details

Details for the file pyprep-0.4.3-py2.py3-none-any.whl.

File metadata

  • Download URL: pyprep-0.4.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 34.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for pyprep-0.4.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3150aa7ce8a7134ffe0c884fd9a630a9d284a06768c08e054f3cbfd233cb9873
MD5 8fb000ab9b973cc4f6bab2e7ff3f16ff
BLAKE2b-256 a05e2a5afbd85dee5af99382130839abd169e9448264be9c623d7423ccdd14d1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page