echopy 1.1.0
Fisheries acoustic data processing in Python

[![](https://img.shields.io/badge/-github-blueviolet?style=plastic)](https://github.com/open-ocean-sounding/echopy)
[![](https://img.shields.io/badge/-pypi-blue?style=plastic)](https://pypi.org/project/echopy)
[![](https://img.shields.io/badge/-readthedocs-9cf?style=plastic)](https://readthedocs.org/projects/echopy)  
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/echopy?style=plastic)](https://www.python.org/)
![Lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg?style=plastic)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/echopy?label=PyPI%20downloads&style=plastic)](https://badge.fury.io/py/echopy)
[![GitHub](https://img.shields.io/github/license/open-ocean-sounding/echopy?style=plastic)](https://github.com/open-ocean-sounding/echopy/blob/master/LICENSE.md)

![](https://raw.githubusercontent.com/open-ocean-sounding/echopy/master/logo.png)

Echopy is a multipurpose library containing common algorithms for fisheries acoustic data processing, such as background noise correction, removal of seabed and corrupted pings, target detection, multifrequency analysis, and binning. The library provides building blocks that can be assembled for a variety of fisheries acoustics applications and is committed to transparency, cooperation, and universal access in fisheries acoustics software.

## Installation
Echopy requires [Python 3.6](https://www.python.org/)

To install echopy and all its [requirements](https://github.com/open-ocean-sounding/echopy/blob/master/requirements.md) type the following in your preferred command-line terminal:
```
pip install echopy
```

or install the latest version available in the develop branch by cloning the repository: 
```
git clone https://github.com/open-ocean-sounding/echopy.git
pip install ./echopy
```

## Contributing
Echopy has essentially grown from code that was initially implemented to support specific research projects, and later made publicly available for the benefit of all. If you work in fisheries acoustics, there are several ways you can contribute to improve Echopy. You might create an [issue](https://github.com/open-ocean-sounding/echopy/issues), propose an improvement or report a bug, or even create your own repository branch, work on it, and [send pull requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/working-with-forks) to the main branch. By doing so, you can  give visibility to your algorithms in fisheries acoustics, while making life easier for your colleagues. Echopy has an [acknowledgments policy](https://github.com/open-ocean-sounding/echopy/blob/master/contribute.md#acknowledgements-policy) to make sure that your work is credited. Check out the [contribution](https://github.com/open-ocean-sounding/echopy/blob/master/contribute.md) section if you want to be part of Echopy.

## Maintainers
* [**Alejandro Ariza**](https://github.com/alejandro-ariza) - *French National Research Institute for Sustainable Development (IRD)*

## Contributors
* [**Alejandro Ariza**](https://github.com/alejandro-ariza) - *French National Research Institute for Sustainable Development (IRD)*
* [**Robert Blackwell**](https://github.com/RobBlackwell) - *British Antarctic Survey*
* [**Sophie Fielding**](https://github.com/bas-sof) - *British Antarctic Survey*
* [**Etienne Pauthenet**](https://github.com/EPauthenet) - *LOCEAN, Sorbonne Université*
* **Xinliang WANG** - *Yellow Sea Fisheries Research institute*

## Acknowledgments
Echopy does not currently have any direct funding, but benefits from the hard work, time  and support of researchers and their institutions. We acknowledge [all contributors and institutions involved](https://github.com/open-ocean-sounding/echopy/blob/master/README.md#contributors) with special mention of the British Antarctic Survey project [RapidKrill](https://github.com/bas-acoustics/rapidkrill), and [The Antarctic Wildlife Research Fund (AWR)](http://www.antarcticfund.org/) for releasing the first version and giving life to Echopy.  

## License
This software is licensed under the [MIT License](https://github.com/open-ocean-sounding/echopy/blob/master/LICENSE).

## Contact
[echopy@protonmail.com](mailto:echopy@protonmail.com)