Add speed test - Githubissues

ioos / ioos_qc

:ballot_box_with_check: :ocean: IOOS QARTOD and other Quality Control tests implemented in Python

https://ioos.github.io/ioos_qc/

Apache License 2.0

46 stars 27 forks source link

Add speed test #38

Closed jessicaaustin closed 3 years ago

jessicaaustin commented 3 years ago

Addresses https://github.com/ioos/ioos_qc/issues/36

Changes:

Add new module argo
- this module defines tests based on ARGO QC Manual
Deprecated glider module and moved glider.pressure_check to argo.pressure_increasing_test
add argo.speed_test
use pygc instead of pyproj for dist calc
- this uses Karney instead of Vincenty for distance calculation. Karney converges for all points, whereas Vincenty fails to converge for nearly antipodal points
- this affects existing test qartod.location_test when range_max is used
moving a few things to utils so they can be shared between qartod and moving_platforms -- nothing changed during the move

Questions/discussion for reviewers:

~~Thoughts on the moving_platforms module? is the name ok? any desire to group with gliders?~~ -- resolved, see comments below

jessicaaustin commented 3 years ago

@kwilcox could you please review?

@lukecampbell if you have a chance, could you please check the distance calcs specifically?

Thanks!

kwilcox commented 3 years ago

moving_platforms is a very Axiom-heavy term... but does describe this well. We could start with a platforms folder and nest different types there (ioos_qc/platforms/moving)? I don't feel strongly, we can leave it like this and see how it grows.

We could also have a contrib or general module that contains these higher-level tests that are applicable to many different types of data and are not described by a specific testing manual.

jessicaaustin commented 3 years ago

Yeah I was trying to think of something generic; "moving platforms" sounded generic enough to me? ¯\_(ツ)_/¯ It could describe gliders, AUVs, floats, animals, etc.

We could also call it argo -- the ARGO QC manual describes both the speed test and the pressure check (both on pg 7). That would fit the pattern of naming modules after manuals.

Or we could just have a "general" module so we don't have to worry so much about what bucket a test falls into.

kwilcox commented 3 years ago

Let's go with either argo or general and put the pressure check there as well. Your call.

jessicaaustin commented 3 years ago

Ok I'm gonna do argo. That's what my heart says

jessicaaustin commented 3 years ago

Ok @kwilcox i'm happy with merging this if you are