Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add visualize doc and ignore ipynb for pre-commit #655

Merged
merged 2 commits into from
May 18, 2022
Merged
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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ repos:
rev: v2.1.0
hooks:
- id: codespell
args: ["-w", "docs/source", "echopype"]
args: ["--skip=*.ipynb", "-w", "docs/source", "echopype"]
Binary file added docs/source/_static/ek500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ parts:
- file: open-converted
- file: process
- file: data-format
- file: viz
- caption: Help & reference
chapters:
- file: api
Expand Down
7 changes: 7 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ API components that most users will interact with.
* `Combine EchoData objects`_
* `Data processing subpackages`_
* `Utilities`_
* `Visualization subpackage`_


EchoData class
Expand Down Expand Up @@ -76,3 +77,9 @@ Utilities
:no-inheritance-diagram:
:no-heading:
:members: calc_absorption, calc_sound_speed

Visualization subpackage
------------------------

.. automodule:: echopype.visualize
:members: create_echogram
163 changes: 163 additions & 0 deletions docs/source/viz.ipynb

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions echopype/visualize/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
Visualization module to quickly plot raw, Sv, and MVBS dataset.

**NOTE: To use this subpackage. `Matplotlib` and `cmocean` package must be installed.**
"""
from .api import create_echogram
from . import cm

Expand Down