Welcome to ecosound’s documentation!
Ecosound is an open source python package to facilitate the analysis of passive acoustic data. It includes modules for manual annotation processing and visualization, automatic detection, signal classification, and localization. It heavily relies on libraries such as xarray, pandas, numpy and scikit-learn. Under the hood it also uses dask which supports the processing of large data sets that don’t fit into memory, and makes processing scalable through distributed computing (on either local clusters or on the cloud). Outputs from ecosound are compatible with popular bioacoustics software such as Raven and PAMlab.
Installation
Ecosound can be installed from PyPI using pip:
pip install ecosound
Quick Start Example
The example below loads a Raven annotation file, filters detections by confidence, and plots a summary heatmap:
from ecosound.core.annotation import Annotation
# Load annotations from a Raven selection table
annot = Annotation()
annot.from_raven('my_annotations.txt', class_header='Sound type')
# Keep only high-confidence detections
annot.data = annot.data[annot.data['confidence'] >= 0.8]
# Aggregate and visualise
annot.plot_heatmap()
API Reference:
Status
Ecosound is very much a work in progress and is still under heavy development. At this stage, it is recommended to contact the main contributor before using ecosound for your projects.
GitHub repository
Contributors
Xavier Mouy (@XavierMouy), Acoustics and Conservation Technology (ACT) Lab, Woods Hole Oceanographic Institution (WHOI).
Support
This project has received funding and support from:
License
Ecosound is licensed under the open source BSD-3-Clause License.