Metadata-Version: 2.1
Name: birdvoxdetect
Version: 0.1.2
Summary: Bioacoustic monitoring of nocturnal bird migration
Home-page: https://github.com/BirdVox/birdvoxdetect
Author: Vincent Lostanlen, Justin Salamon, Andrew Farnsworth, Steve Kelling, and Juan Pablo Bello
Author-email: vincent.lostanlen@nyu.edu
License: MIT
Project-URL: Source, https://github.com/BirdVox/birdvoxdetect
Project-URL: Tracker, https://github.com/BirdVox/birdvoxdetect/issues
Project-URL: Documentation, https://readthedocs.org/projects/birdvoxdetect/
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](https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6-blue.svg)]()
        [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
        [![Coverage Status](https://coveralls.io/repos/github/BirdVox/birdvoxdetect/badge.svg)](https://coveralls.io/github/BirdVox/birdvoxdetect)
        [![Build Status](https://travis-ci.org/BirdVox/birdvoxdetect.svg?branch=master)](https://travis-ci.org/BirdVox/birdvoxdetect)
        [![Documentation Status](https://readthedocs.org/projects/birdvoxdetect/badge/?version=latest)](http://birdvoxdetect.readthedocs.io/en/latest/?badge=latest)
        
        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<br/>
        Vincent Lostanlen, Justin Salamon, Andrew Farnsworth, Steve Kelling, and Juan Pablo Bello<br/>
        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](https://www.tensorflow.org/install/).
        
        #### 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](https://pysoundfile.readthedocs.io/en/0.9.0/#installation>).
        
        
        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<br/>
        Vincent Lostanlen, Justin Salamon, Andrew Farnsworth, Steve Kelling, and Juan Pablo Bello<br/>
        PLoS ONE 14(10): e0214168. https://doi.org/10.1371/journal.pone.0214168
        
Keywords: tfrecord
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: tests
