Skip to main content
docs/source/_static/ecosound_logo_small.png

Welcome to ecosound!

https://img.shields.io/pypi/v/ecosound.svg Documentation Status Total PyPI downloads Monthly PyPI downloads GitHub stars GitHub forks

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.

Features

  • Annotation — load, filter, merge, and export manual annotations from Raven and PAMlab

  • Audio tools — read audio files, apply filters, compute spectrograms

  • Detection — plug-in detectors (blob, kurtosis) with a common factory interface

  • Classification — apply trained scikit-learn classifiers to acoustic measurements

  • Measurements — extract spectral and temporal features from annotated signals

  • Evaluation — compute Precision, Recall, and F-score curves for detectors

  • Environment — fetch co-located oceanographic, weather, tidal, and AIS data

  • Soundscape — process Hybrid Millidecade (HMD) spectral data for long-term soundscape analysis

  • Visualization — plot waveforms, spectrograms, annotation heatmaps, and interactive AIS maps

Installation

pip install ecosound

Quick Start

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()

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.

Documentation

Full API documentation is available at https://ecosound.readthedocs.io.

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.

History

0.0.0 (2020-11-20)

  • First release on PyPI.

Metadata

Release files for ecosound 0.0.32

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ecosound 0.0.32
File Size Uploaded
ecosound-0.0.32.tar.gz 3.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ecosound 0.0.32
File Interpreter ABI Platform
ecosound-0.0.32-py3-none-any.whl Python 3 none any Details

Total release size: 4.1 MB

Release files / ecosound-0.0.32.tar.gz

Download URL ecosound-0.0.32.tar.gz
Size 3.8 MB
Tags Source
SHA-256 checksum
How to use checksums
df953b5e308dad8d588596b897b54a0e69e955375891cfca43d15fae7ff026c2
BLAKE2b-256 checksum
How to use checksums
6a1fd6ef9e348d2a4b6204bbe7e395f9405220778d06936f8ff4a68dd2526b66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release files / ecosound-0.0.32-py3-none-any.whl

Download URL ecosound-0.0.32-py3-none-any.whl
Size 312.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1aaa489b8239890988302139f30df1f954047a52dfd1a9647cf59078d813aa4f
BLAKE2b-256 checksum
How to use checksums
a24dcfd1e5807489316d4a5a3ce2f497a2743003904937801d92abf890d4f498
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release history Release notifications | RSS feed

This release

0.0.32 This release

2 release files

0.0.31

2 release files

0.0.30

2 release files

0.0.29

2 release files

0.0.28

2 release files

0.0.26

2 release files

0.0.23

2 release files

0.0.22

2 release files

0.0.21

2 release files

0.0.20

2 release files

0.0.19

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

3 release files

0.0.3

3 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page