Metadata-Version: 2.1
Name: ecosound
Version: 0.0.32
Summary: Python toolkit for analysing passive acoustic data
Home-page: https://github.com/xaviermouy/ecosound
Author: Xavier Mouy
Author-email: xaviermouy@uvic.ca
License: BSD license
Keywords: ecosound
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: xarray[complete]
Requires-Dist: dask[complete]
Requires-Dist: pandas
Requires-Dist: numba
Requires-Dist: dask-image
Requires-Dist: matplotlib
Requires-Dist: ipympl
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: scikit-learn
Requires-Dist: toolz
Requires-Dist: opencv-python >=4.5.5.64
Requires-Dist: soundfile >=0.10.0
Requires-Dist: netCDF4
Requires-Dist: tqdm
Requires-Dist: pooch
Requires-Dist: eccodes ==1.2.0
Requires-Dist: Pillow
Requires-Dist: aiohttp
Requires-Dist: branca
Requires-Dist: duckdb
Requires-Dist: folium
Requires-Dist: geopandas
Requires-Dist: plotly
Requires-Dist: shapely
Requires-Dist: PyYAML


.. image:: docs/source/_static/ecosound_logo_small.png


Welcome to ecosound!
====================

.. image:: https://img.shields.io/pypi/v/ecosound.svg
        :target: https://pypi.python.org/pypi/ecosound

.. image:: https://readthedocs.org/projects/ecosound/badge/?version=latest
        :target: https://ecosound.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://static.pepy.tech/badge/ecosound
    :target: https://pepy.tech/project/ecosound
    :alt: Total PyPI downloads

.. image:: https://img.shields.io/pypi/dm/ecosound
    :target: https://pypi.python.org/pypi/ecosound
    :alt: Monthly PyPI downloads

.. image:: https://img.shields.io/github/stars/xaviermouy/ecosound?style=social
    :target: https://github.com/xaviermouy/ecosound
    :alt: GitHub stars

.. image:: https://img.shields.io/github/forks/xaviermouy/ecosound?style=social
    :target: https://github.com/xaviermouy/ecosound
    :alt: 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 <https://ravensoundsoftware.com/>`_ and
`PAMlab <https://static1.squarespace.com/static/52aa2773e4b0f29916f46675/t/5be5b07088251b9f59268184/1541779574284/PAMlab+Brochure.pdf>`_.


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

.. code-block:: bash

   pip install ecosound


Quick Start
-----------

.. code-block:: python

   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 <https://xaviermouy.weebly.com/>`_ (@XavierMouy),
Acoustics and Conservation Technology (ACT) Lab,
Woods Hole Oceanographic Institution (WHOI).


Support
-------

This project has received funding and support from:

* `Woods Hole Oceanographic Institution (WHOI) <https://www.whoi.edu/>`_
* `NOAA Fisheries <https://www.fisheries.noaa.gov/>`_
* `Canadian Healthy Oceans Network (CHONe) <https://chone2.ca/>`_
* `University of Victoria <https://www.uvic.ca/>`_
* `Fisheries and Oceans Canada <https://www.dfo-mpo.gc.ca/>`_


License
-------
Ecosound is licensed under the open source `BSD-3-Clause License <https://choosealicense.com/licenses/bsd-3-clause/>`_.


=======
History
=======

0.0.0 (2020-11-20)
------------------

* First release on PyPI.
