Skip to content

Commit

Permalink
Merge pull request #14 from leewujung/clean-post
Browse files Browse the repository at this point in the history
Small updates before ms posting
  • Loading branch information
emiliom authored Oct 28, 2021
2 parents d902971 + 66f27b4 commit 8a39759
Show file tree
Hide file tree
Showing 5 changed files with 1,303 additions and 314 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

## Purpose

This repository illustrates the functionalities of [echopype](https://echopype.readthedocs.io/en/stable/), an open-source Python library that enables interoperability and scalability in water column sonar data analysis. The materials can be found within the [notebooks](https://github.com/OSOceanAcoustics/echopype-examples/tree/main/notebooks) folder in `.ipynb` files, which are [Jupyter notebooks](https://realpython.com/jupyter-notebook-introduction/). Open the [index.ipynb](https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/index.ipynb) notebook to see an index of the existing example notebooks. To see the notebooks accurately rendered (GitHub notebook rendering has shortcomings), [open the index notebook in https://nbviewer.org](https://nbviewer.org/github/OSOceanAcoustics/echopype-examples/blob/main/notebooks/index.ipynb).
This repository illustrates the functionalities of [echopype](https://echopype.readthedocs.io/en/stable/), an open-source Python library that enables interoperability and scalability of water column sonar data processing.
The materials can be found within the [notebooks](https://github.com/OSOceanAcoustics/echopype-examples/tree/main/notebooks) folder in `.ipynb` files, which are [Jupyter notebooks](https://realpython.com/jupyter-notebook-introduction/).
Open the [index.ipynb](https://github.com/OSOceanAcoustics/echopype-examples/blob/main/notebooks/index.ipynb) notebook to see an index of the existing example notebooks.
To see the notebooks accurately rendered (GitHub notebook rendering has shortcomings), [open the index notebook at https://nbviewer.org](https://nbviewer.org/github/OSOceanAcoustics/echopype-examples/blob/main/notebooks/index.ipynb).

To actively explore and run the notebooks without downloading them or having to configure a Python environment locally, open them with https://mybinder.org:
- Click on the "launch binder" badge above to launch a sandbox copy. The typical start time is about 3 minutes.
Expand Down
15 changes: 8 additions & 7 deletions binder/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ name: echopype
channels:
- conda-forge
dependencies:
- python=3.8
- python=3.9
- ipykernel
- hvplot
- holoviews=1.14.5
# - panel
- datashader
- cartopy
- geopandas=0.9.0
- echopype=0.5.4
- aiobotocore
- geopandas
- cartopy
# -- holoviz --
- datashader
- holoviews
- hvplot
14 changes: 12 additions & 2 deletions notebooks/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,25 @@
"- [ms_PacificHake_EK60_cruisetracks.ipynb](ms_PacificHake_EK60_cruisetracks.ipynb). Exploring ship echosounder data from the Pacific Hake survey. Goals:\n",
" 1. Illustrate a common workflow for echosounder data conversion, calibration and use.\n",
" 2. Extract and visualize echosounder data (EK60) with relative ease using geospatial and temporal filters. \n",
" \n",
" \n",
"- [ms_OOI_EK60_mooringtimeseries.ipynb](ms_OOI_EK60_mooringtimeseries.ipynb). Wacthing a solar eclipse using a moored echosounder. Goals:\n",
" 1. Illustrate a common workflow for echosounder data conversion, calibration and use.\n",
" 2. Demonstrate the ease to interoperate echosounder data (EK60) with those from a different instrument in a single computing environment. Without echopype, additional wrangling across more than one software systems is needed to achieve the same visualization and comparison."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "b27998ce",
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
Expand All @@ -40,7 +50,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.7"
"version": "3.8.0"
}
},
"nbformat": 4,
Expand Down
Loading

0 comments on commit 8a39759

Please sign in to comment.