Metadata-Version: 2.1
Name: pybispectra
Version: 1.1.0
Summary: A Python signal processing package for computing spectral-domain and time-domain interactions using the bispectrum.
Project-URL: Homepage, https://github.com/braindatalab/PyBispectra
Project-URL: Bug Tracker, https://github.com/braindatalab/PyBispectra/issues
Author-email: Thomas Samuel Binns <t.s.binns@outlook.com>
License-File: LICENSE.txt
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.12,>=3.10
Requires-Dist: joblib
Requires-Dist: matplotlib
Requires-Dist: mne
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pqdm
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: codespell; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: ipywidgets; extra == 'dev'
Requires-Dist: notebook; extra == 'dev'
Requires-Dist: numpydoc; extra == 'dev'
Requires-Dist: pycodestyle; extra == 'dev'
Requires-Dist: pydata-sphinx-theme; extra == 'dev'
Requires-Dist: pydocstyle; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-gallery; extra == 'dev'
Requires-Dist: sphinxcontrib-bibtex; extra == 'dev'
Description-Content-Type: text/markdown

![](docs/source/_static/logo.gif)

A Python signal processing package for computing spectral- and time-domain
interactions using the bispectrum.

This package provides the tools for computing phase-amplitude coupling, time
delay estimation, and wave shape features using the bispectrum and bicoherence.
Additional tools for computing amplitude-amplitude coupling, phase-phase
coupling, and spatio-spectral filters are also provided.

Parallel processing and [Numba](https://numba.pydata.org/) optimisation are
implemented to reduce computation times. There is a minor reliance on the
[MNE](https://mne.tools/stable/index.html) signal processing toolbox.

## Installation & Requirements:
Install the package into the desired environment using pip `pip install pybispectra`<br/>
[See here for the list of requirements](requirements.txt).

## Use:
To get started with the toolbox, check out the [documentation](https://pybispectra.readthedocs.io/en/main/) and [examples](https://pybispectra.readthedocs.io/en/main/examples.html).

## Citing:
If you use this toolbox in your work, please include the following citation:<br/>
Binns, T. S., Pellegrini, F., Jurhar, T., & Haufe, S. (2023). PyBispectra (Version 1.1.0). DOI: [10.5281/zenodo.8377822](https://doi.org/10.5281/zenodo.8377822)