This repository illustrates the functionalities of echopype, an open-source Python library that enables interoperability and scalability of water column sonar data processing. The materials can be found within the notebooks folder in .ipynb files, which are Jupyter notebooks. Open the index.ipynb notebook to see an index of the existing example notebooks with brief descriptions.

Open the JupyterBook version of the notebook collection to see the notebooks accurately rendered (GitHub notebook rendering has shortcomings) and in a more convenient organization.

To actively explore and run the notebooks without downloading them or having to configure a Python environment locally, open them with https://mybinder.org either by clicking on the "launch binder" badge above to launch a sandbox copy or via the "launch" icon (a rocket) on each notebook in the JupyterBook, in the upper right. The typical start time is about 3 minutes. Once binder finishes spinning up, try running the first notebook. Currently, some notebooks may fail to run to completion in binder due to memory demands that exceed what is available on binder. When you are done, just close the browser tab and the sandbox will be removed.

To run the notebooks locally in your computer, clone this repository and create a conda environment using the conda environment file environment.yml found in the binder folder:

conda env create -f environment.yml