README.md

Biotuner

Python toolbox that incorporates tools from biological signal processing and musical theory to extract harmonic structures from biosignals.

🧬🎵 Visit the documentation page

Installation

1. Install using PyPI

pip install biotuner

2. Install using Github Repository:

2.1. Create a Python environment with v3.8 using conda:

conda create --name biotuner_env python=3.8
conda activate biotuner_env

2.2. Clone the Biotuner repository:

git clone https://github.com/AntoineBellemare/biotuner.git
cd biotuner

2.3. Install the package:

pip install -e .

Simple use case

biotuning = biotuner(sf = 1000) #initialize the object
biotuning.peaks_extraction(data, peaks_function='FOOOF') #extract spectral peaks
biotuning.compute_peaks_metrics() #get consonance metrics for spectral peaks

Peaks extraction methods