-
Notifications
You must be signed in to change notification settings - Fork 46
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
Dolfyn cleaning function updates #354
Conversation
@jmcvey3 is this ready for review? |
It is. I've also done some serious reorganizing of the I/O files in an attempt to make them easier to follow, and have added a few random fixes for random hiccups. The fix for 535 is in the first couple commits. |
Thanks James. I plan to tackle this Monday. |
…ython into cleaning_updates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jmcvey3 thanks for fixing the bug and improving the modularity of the dolfyn module.
I was adding docstrings to what I thought were new functions but realized they were primarily moved functions in our meeting yesterday. As such I will finish improving docstrings when we get to linting this module in the future.
That said could you review the proposed docstrings I already did?
Yep, and sounds like a plan |
@ssolson Did you want me to update certain files with docstrings and typehints in this PR, or shall we merge this one as is and do so in another? |
…ython into cleaning_updates
Renames and makes the functions that calculate water depth and remove surface interference more robust. The functions were designed around Nortek ADCPs but didn't take into account the calculations RDI already does. Errors or warnings will guide the user through the proper use of functions if previous calculations were already completed or data is missing.
Also removes the "ignore rankwarning" as some users may not want to do so, and updates future package deprecations.
Solves the problems Calum and I found in Issue #353. Tests were updated as appropriate.
Also added some fixes for determining beam angle and carrier frequency attributes for Sentinel V ADCPs.