Skip to content

Repository files navigation

DataViewerSpectrum

pyBOAT - A Biological Oscillations Analysis Toolkit

Join the chat at https://gitter.im/pyBOATbase/support PyPI version Conda Version Conda Downloads Tests

Tools for time-frequency analysis of noisy time series. More details can be found in the accompanying manuscript Optimal time frequency analysis for biological data - pyBOAT. For help, questions or comments please join the official chat on gitter, write an issue or start a discussion.

Installation

Documentation

pyBOAT features a modular, multi-layered graphical user interface. The example screenshot displays the DataViewer(left) used for signal inspection and preprocessing, paired with the resulting Wavelet Spectrum, which shows a ridge tracking the main oscillatory component with a $\sim$ 24h period (right):

DataViewerSpectrum

Features

  • x-platform GUI
  • High-pass sinc filter
  • Fourier analysis
  • Wavelet analysis
  • Ridge detection, phase and amplitude extraction
  • Synthetic signal generator
  • Batch processing
  • Ensemble statistics

See also the sister project SpyBoat for spatially resolved time-frequency analysis with wavelets.

Installation

Linux:

python -m venv venv-pyboat
source venv-pyboat/bin/activate
pip install pyboat

MacOS:

Download the latest pyBOAT-1.x.x.dmg file from the release page. To install and launch, you will need to bypass the macOS untrusted developer warning twice by right-clicking and selecting 'Open': first on the downloaded .dmg installer file, and then a second time on the installed pyBOAT app inside Finder.

Windows

Download the latest pyBOAT-1.x.x.msi file from the release page and run the setup wizard to install.

Via Anaconda Navigator (legacy)

See here..

Documentation

For the public API see the single signal demonstration and the ensemble statistics example. Consult the respective Python docstrings for further details.

Quick install via command line

With pip:

pip install pyboat

or with conda:

conda install -c conda-forge pyboat

Then start the UI from the terminal:

pyboat

or use import pyboat in your Python scripts.

About

A Biological Oscillations Analysis Toolkit

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages