Skip to content

Commit

Permalink
add deprecation warning at epviz import (#1310)
Browse files Browse the repository at this point in the history
  • Loading branch information
leewujung authored Apr 24, 2024
1 parent ae911de commit 2a0e637
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions echopype/visualize/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,19 @@
**NOTE: To use this subpackage. `Matplotlib` and `cmocean` package must be installed.**
"""
import warnings
from .api import create_echogram
from . import cm

__all__ = ["create_echogram", "cm"]

warnings.warn(
(
"`echopype.visualization` is deprecated and will be removed in an upcoming release. \n"
"Use Echoshader for visualization functions instead. \n"
"Repository: https://github.com/OSOceanAcoustics/echoshader \n"
"Echogram plotting: https://echoshader.readthedocs.io/en/latest/version_0.1.0/echogram_examples.html" # noqa
),
DeprecationWarning,
2,
)

0 comments on commit 2a0e637

Please sign in to comment.