Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ __pycache__/
# C extensions
*.so

# Notebook example datasets downloaded locally
example_data/*/

# Distribution / packaging
.Python
build/
Expand Down
1 change: 1 addition & 0 deletions conda/environment-ep-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dependencies:
- numba # Helps ensure a recent version is installed
- numpy<2
- pip
- pooch
# -- holoviz --
- jupyter_bokeh
- datashader
Expand Down
1 change: 1 addition & 0 deletions conda/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ dependencies:
- cartopy
- scipy
- numba # Helps ensure a recent version is installed
- pooch
# -- holoviz --
- jupyter_bokeh
- datashader
Expand Down
6 changes: 3 additions & 3 deletions notebooks/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ latex:

# Information about where the book exists on the web
repository:
url: https://github.com/OSOceanAcoustics/echopype-examples # Online location of your book
path_to_book: notebooks # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)
url: https://github.com/echostack-org/echopype-examples
path_to_book: notebooks
branch: main

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
Expand Down
1 change: 1 addition & 0 deletions notebooks/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ parts:
- file: krill_freq_diff
- file: hake_mask
- file: glider_AZFP
- file: resample_to_geometry

- caption: Community showcase
numbered: False
Expand Down
39 changes: 23 additions & 16 deletions notebooks/gallery.yml
Original file line number Diff line number Diff line change
@@ -1,62 +1,69 @@
- section: Getting started
items:
- name: Getting Started with Echopype
website: https://echopype-examples.readthedocs.io/en/latest/getting_started.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/getting_started.ipynb
website: getting_started.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/getting_started.ipynb
notebook: getting_started.ipynb
summary: A minimum example to get started on Echopype functions.
image: images/gallery/01_getting_started.png

- section: Processing
items:
- name: Watching Eclipse from a Moored Echosounder
website: https://echopype-examples.readthedocs.io/en/latest/OOI_eclipse.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/OOI_eclipse.ipynb
website: OOI_eclipse.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/OOI_eclipse.ipynb
notebook: OOI_eclipse.ipynb
summary: Pairing acoustic data from an upward-looking echosounder and shortwave irradiance measured by a pyrometer on a surface mooring to observe the movement response of zooplankton to a solar eclipse. (Not binder friendly.)
image: images/gallery/02_OOI_eclipse.png

- name: Seafloor Detection
website: https://echopype-examples.readthedocs.io/en/latest/seafloor_detection.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/seafloor_detection.ipynb
website: seafloor_detection.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/seafloor_detection.ipynb
notebook: seafloor_detection.ipynb
summary: Seafloor detection with echopype (two algorithms) and use of echoregions; compute a bottom line and mask below-bottom data.
image: images/gallery/07_seafloor.png

- name: Transient Noise Removal
website: https://echopype-examples.readthedocs.io/en/latest/transient_noise.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/transient_noise.ipynb
website: transient_noise.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/transient_noise.ipynb
notebook: transient_noise.ipynb
summary: Transient noise removal with echopype (two algorithms) and exploring the effects on Sv profiles.
image: images/gallery/08_transient_noise.png

- name: Ship Tracks Visualisation
website: https://echopype-examples.readthedocs.io/en/latest/ship_tracks.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/ship_tracks.ipynb
website: ship_tracks.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/ship_tracks.ipynb
notebook: ship_tracks.ipynb
summary: Subselect sections of echo data based on ship GPS data embedded in the echosounder raw files to demonstrate the power of label-aware data processing based on standardized netCDF data model. (Not binder friendly.)
image: images/gallery/03_subselection.png

- name: Krill Frequency Differencing
website: https://echopype-examples.readthedocs.io/en/latest/krill_freq_diff.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/krill_freq_diff.ipynb
website: krill_freq_diff.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/krill_freq_diff.ipynb
notebook: krill_freq_diff.ipynb
summary: Perform frequency-differencing analysis to identify fluid-like zooplankton scatterers (likely krill) in ship echosounder data, and compute nautical acoustic scattering coefficient (NASC) based on the classification. (Not binder friendly.)
image: images/gallery/04_krill.png

- name: Masking Echogram and Computing NASC
website: https://echopype-examples.readthedocs.io/en/latest/hake_mask.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/hake_mask.ipynb
website: hake_mask.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/hake_mask.ipynb
notebook: hake_mask.ipynb
summary: Incorporate an externally generated mask that identify the occurrence of Pacific hake in ship echosounder data, and compute NASC based on the masked outputs.
image: images/gallery/05_NASC.png

- name: Glider AZFP Processing
website: https://echopype-examples.readthedocs.io/en/latest/glider_AZFP.html
repository: https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/glider_AZFP.ipynb
website: glider_AZFP.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/glider_AZFP.ipynb
notebook: glider_AZFP.ipynb
summary: Process acoustic data from a Slocum glider by incorporating external position, motion, and environmental data and identify zooplankton shoals.
image: images/gallery/06_glider.png

- name: Resample Channels to a Common Range Geometry
website: resample_to_geometry.html
repository: https://github.com/echostack-org/echopype-examples/blob/main/notebooks/resample_to_geometry.ipynb
notebook: resample_to_geometry.ipynb
summary: Resample acoustic variables across channels to a reference channel geometry or a custom ping-dependent range grid.
image: images/gallery/10_resample_to_geometry.png

- section: Community showcase
items: []
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading