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 are presented as Jupyter notebooks (.ipynb files) in the notebooks folder.

Click here to see the notebooks accurately rendered with a clean and convenient organization.

To actively explore and run the notebooks without downloading them or having to configure a Python environment locally, open them with Binder either by clicking on the "launch binder" badge above to launch a sandbox copy or the "launch" icon (a rocket) on the upper right corner of each notebook in the JupyterBook.

The typical Binder start time is about 3 minutes. Once Binder finishes spinning up, try running the first notebook. Below are a few things to bear in mind:

• The index.md file contains an index of the existing example notebooks with brief descriptions
• 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 (git clone https://github.com/OSOceanAcoustics/echopype-examples.git) and create a conda environment using the conda environment file environment.yml found in the binder folder:

conda env create -f environment.yml

This will create a new environment called `echopype.

First, clone this repository (see section above). Then, decide what kind of echopype environment you'd like to use.

To test and develop notebooks using the latest echopype release:

• Follow the instructions above to create a conda environment.
• Activate the new environment. Assuming you used the default environment name: conda activate echopype
• Install jupyter-book: conda install -c conda-forge jupyter-book

To test and develop notebooks with the latest echopype development branch, go through the following steps:

• Install an echopype development environment. First, run this conda create command (or better yet, use mamba instead of conda):

  conda create -c conda-forge -n echopype --yes python=3.9 --file https://raw.githubusercontent.com/OSOceanAcoustics/echopype/dev/requirements.txt --file https://raw.githubusercontent.com/OSOceanAcoustics/echopype/dev/requirements-dev.txt --file https://raw.githubusercontent.com/OSOceanAcoustics/echopype/dev/docs/requirements.txt

• Activate the new environment: conda activate echopype
• Install additional packages:

  conda install -c conda-forge geopandas cartopy datashader holoviews hvplot

• Run pip install -e ".[plot]"

Regardless of which echopype environment you built:

• Activate the new echopype environment
• cd to your echopype-examples repository clone base folder, eg, /path/to/clone/echopype-examples
• Build the jupyter book: jupyter-book build notebooks