Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Bioacoustic monitoring of nocturnal bird migration

Project description

BirdVoxDetect: robust sound event detection of bird flight calls

An open-source Python library and command-line tool for automatically detecting bird flight calls in audio recordings.

PyPI MIT license Coverage Status Build Status Documentation Status

BirdVoxDetect is a pre-trained deep learning system for detecting bird flight calls in continuous audio recordings. It relies on per-channel energy normalization (PCEN) and context-adaptive convolutional neural network (CA-CNN) for improved robustness to background noise. It is made available both as a Python library and as a command-line tool for Windows, OS X, and Linux.

For details about the deep learning model in BirdVoxDetect and how it was trained, we refer the reader to:

Robust Sound Event Detection in Bioacoustic Sensor Networks
Vincent Lostanlen, Justin Salamon, Andrew Farnsworth, Steve Kelling, and Juan Pablo Bello
Under review, 2019.

Installation instructions

Dependencies

TensorFlow

Because TensorFlow comes in CPU-only and GPU-enabled variants, we leave it up to the user to install the version that best fits their use case.

On most platforms, either of the following commands should properly install TensorFlow:

pip install tensorflow # CPU-only version
pip install tensorflow-gpu # GPU-enabled version

For more detailed information, please consult the installation instructions of TensorFlow.

libsndfile (Linux only)

BirdVoxDetect depends on the PySoundFile module to load audio files, which itself depends on the non-Python library libsndfile. On Windows and Mac OS X, these will be installed automatically via the pip package manager and you can therefore skip this step. However, on Linux, libsndfile must be installed manually via your platform's package manager. For Debian-based distributions (such as Ubuntu), this can be done by simply running

apt-get install libsndfile

For more detailed information, please consult the installation instructions of pysoundfile.

Installing BirdVoxDetect

The simplest way to install BirdVoxDetect is by using pip, which will also install the additional required dependencies if needed.

To install the latest version of BirdVoxDetect from source:

  1. Clone or pull the latest version:

     git clone git@github.com:BirdVox/birdvoxdetect.git
    
  2. Install using pip to handle Python dependencies:

     cd birdvoxdetect
     pip install -e .
    

Acknowledging BirdVoxDetect

Please cite the following paper when using BirdVoxDetect in your work:

[1] Robust Sound Event Detection in Bioacoustic Sensor Networks
Vincent Lostanlen, Justin Salamon, Andrew Farnsworth, Steve Kelling, and Juan Pablo Bello
PLoS ONE 14(10): e0214168. https://doi.org/10.1371/journal.pone.0214168

Release history Release notifications

Download files

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

Files for birdvoxdetect, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size birdvoxdetect-0.1.2.tar.gz (15.0 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page