OSOceanAcoustics / echopype

Enabling interoperability and scalability in ocean sonar data analysis
https://echopype.readthedocs.io/
Apache License 2.0
89 stars 70 forks source link

Retire the `visualize` subpackage? #1276

Closed leewujung closed 2 days ago

leewujung commented 4 months ago

I am wondering if we should retire the subpackage echopype.visualize (epviz), and keep the EK500 colormap import. Current docs here.

There are a few main reasons:

@valentina-s @lsetiawan: Any thoughts? I know you spent quite a bit of time developing epviz and writing the docs too.

Tasks

lsetiawan commented 3 months ago

Now that all the plotting functionalities are mostly within Echoshader, I agree that this visualize subpackage can be retired. If there's a way to port the EK500 colormap that would be really great!

It seems that instead of having a specialized subpackage, we can just do a better job in the docs to show users how to plot data using native xarray plotting functions.

I really like this idea of showing users how to use xarray plotting functions to build their own static plots!

leewujung commented 3 months ago

Ok, I'll put in a deprecating warning for v0.8.4 and redirect people to Echoshader, and remove it at v0.9.0 (since its current state is buggy and will be very involved to fix).

For docs, it'll take a bit of time to add in examples, but the first thing we can do is to link to xarray dataset/dataarray intros and its plotting documentation, so that people have a good place to find references.

leewujung commented 2 days ago

This can be closed now via #1347.