echopype 0.1

echopype is an open-source toolkit for analyzing active sonar data for biological information in the ocean.

echopype is an open-source toolkit for analyzing active sonar data for biological information in the ocean.

The goal of echopype is to improve the interoperability and scalability in processing water column sonar data.

Functionality

• Convert different manufacturer-specifc data files into an interoperable netCDF format.

• Leverage Python distributed computing libraries in processing large volumes of sonar data in local or cloud storage.

The current version supports converting .raw data files collected by the SimRad EK60 echosounder. Conversion for other types of data files, including the .01A files from AZFP echosounder and the .raw files from the SimRad broadband echosounder, will be added in future releases.

Details of the above can be found here.

Installation

To install echopype, do the following in your terminal:

$ pip install echopype

Using echopype

To batch convert whole bunch of .raw files in the terminal:

$ echopype_converter -s ek60 data/*.raw

This will generate whole bunch of .nc files with the same leading filename in the same directory as the .raw files.

To use the EK60 data converter in a Python session, you can do:

# import as part of a submodule
from echopype.convert import ConvertEK60
data_tmp = ConvertEK60('FILENAME.raw')
data_tmp.raw2nc()

Or:

# import the full module
import echopype as ep
data_tmp = ep.convert.ConvertEK60('FILENAME.raw')
data_tmp.raw2nc()

Same as in the command line case, this will generate a FILENAME.nc in the same directory as FILENAME.raw.

The ConvertEK60 instance contains all the data unpacked from the .raw file, so it is a good idea to clear it from memory once done with conversion.

License

echopype is licensed under the terms of the Apache 2.0 license. See the file “LICENSE” for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

All trademarks referenced herein are property of their respective holders.

Copyright (c) 2018–, Wu-Jung Lee, Applied Physics Laboratory, University of Washington.