This repository is now archived and read-only.
Get the last developing version of Echopy in https://github.com/open-ocean-sounding/echopy
Echopy is a multipurpose library containing common algorithms for fisheries acoustic data processing including: noise removal; binning; seabed detection; and target detection. The library provides building blocks that can be assembled for a variety of fisheries acoustics applications and is aimed towards unsupervised, automatic and large-scale analyses.
Echopy was created by Alejandro Ariza at the British Antarctic Survey as part of the project RapidKrill, which aims to build an automatic system to deliver acustic-based krill estimates from fishing vessels. The project was coordinated by Sophie Fielding with contributions from Robert Blackwell, both members of the BAS-acoustics team. Due to its flexible structure, echopy now aims to be a general purpose library for a variety of acoustic processing routines and welcomes acousticians from around the world to get involved.
Echopy is in its early stages, having implemented only a small part of the countless processing and analysis routines in fisheries acoustics. There is still much to do, and we encourage acousticians to audit the code, provide advice, and implement new algorithms.
If contributing, please read DESIGN.md to adhere to our coding style.
We also provide a telegram channel where beginners can find support, and experts can bring ideas and constructive criticism.
Echopy requires Python 3.6.
Echopy is usually used in conjunction with PyEcholab2. PyEcholab is used to read RAW files and echopy applies common fisheries acoustic data processing techniques.
In addition, echopy uses the following packages
- matplotlib for plotting echograms.
- numpy for large, multi-dimensional arrays.
- scipy for scientific computing.
- toml for configuration files.
- opencv-python for image processing.
- scikit-image for image processing.
Install echopy:
pip install echopy
or download the installer in https://pypi.org/project/echopy.
Notes for maintainers - echopy is packaged acccording to the
Python Packaging User Guide. For
a new release, update the version number in setup.py and echopy/__init__.py and then:
python3 -m pip install --user --upgrade setuptools wheel
python3 setup.py sdist bdist_wheel
python3 -m pip install --user --upgrade twine
python3 -m twine upload dist/*
This allows for installation using pip install echopy.
- Alejandro Ariza - British Antarctic Survey - alejandro-ariza
- Robert Blackwell - British Antarctic Survey - RobertBlackwell
- Sophie Fielding - British Antarctic Survey - SophieFielding
Our thanks to the officers, crew and scientists onboard the RRS James Clark Ross for their assistance in collecting the data. The Western Core Box cruises and SF are funded as part of the Ecosystems Programme at the British Antarctic Survey, Natural Environment Research Council, a part of UK Research and Innovation.
This work was supported by the Antarctic Wildlife Research Fund and the Natural Environment Research Council grant NE/N012070/1.
This software is licensed under the MIT License - see the LICENSE.md file for details