search

lkilcher / dolfyn

A library for oceanographic doppler instruments such as Acoustic Doppler Profilers (ADPs, ADCPs) and Acoustic Doppler Velocimeters (ADVs).
BSD 3-Clause "New" or "Revised" License
42 stars 25 forks source link

Deprecate `do_avg`, `do_var` and `do_tke`? #69

Closed lkilcher closed 2 years ago

lkilcher commented 2 years ago

Not sure these functions are that valuable, and they add bulk to the codebase. I suggest we drop them. I still think the __call__ method (which just averages everything) is useful, which calls do_avg, so we'll need to move that functionality somewhere. Maybe for now we just move it to _do_avg?

@jmcvey3, do you like them? If you don't have a strong opinion, I think we should drop those before merging #67.

jmcvey3 commented 2 years ago

do_avg is a core function for creating and finding the mean of data ensembles, so how would you propose doing that if deprecated? I agree that do_tke adds bulk.

lkilcher commented 2 years ago

Roger. Since do_avg is a major piece of the API, let's just leave do_tke in for now.

lkilcher commented 2 years ago

Also, I've changed my mind on the __call__ method. Let's leave it out in favor of the more explicit do_avg.