PyBic documentation!
PyBic is an open-source module specializing in signal processing, with particular emphasis on polyspectral analysis.
PyBic’s Bicoherence Analyzer class (pybic.BicAn) simplifies the
estimation, visualization, and interpretation of low order polyspectra,
e.g., the cross-spectrum, bispectrum, and trispectrum.
Check out the Theory docs for a brief intro to polyspectra!
Quick start
To get rolling, place the pybic.py file in your desired directory, and try
import pybic as bic
b = bic.BicAn('demo')
Alternatively, to analyze a time-series x sampled at fS, use
import pybic as bic
b = bic.BicAn(x,samprate=fS)
See our Getting started section for more info!
Tutorials
Our (in-development) Read the Docs page provides detailed information about the pybic module and the associated pybic.BicAn class.
For convenience, we’ve developed a number of Examples to get a feel for the module, and the following Jupyter notebooks demonstrate many of PyBic’s features:
Citing our work
To reference PyBic/BicAn, please cite our publication in Computer Physics Communications, BicAn: An integrated, open-source framework for polyspectral analysis.
Note that the preprint is freely available!
Contact
Have a question, comment, or critique? Feel free to reach out to rigzridge@gmail.com!
Hint
This hint is collapsible, but initially open. This links back to the top!
Note
While the pybic module is relatively complete,
this documentation is under active development!
Updates should be coming throughout 2026…
Module docs
Polyspectral analysis toolkit for Python. |