MHKiT-Software / MHKiT-Python

MHKiT-Python provides the marine renewable energy (MRE) community tools for data processing, visualization, quality control, resource assessment, and device performance.
https://mhkit-software.github.io/MHKiT/
BSD 3-Clause "New" or "Revised" License
47 stars 45 forks source link

Dolfyn updates + turbulence analysis #232

Closed jmcvey3 closed 11 months ago

jmcvey3 commented 1 year ago

A slew of bugfixes and inconsistency cleanup, as well as including ADCP turbulence functionality for #227

Changelog:

ssolson commented 1 year ago

James pulling the latest develop branch should fix your test failures

jmcvey3 commented 1 year ago

@browniea I've finished my updates for this PR, though I need to update documentation and add an example notebook. Was there something else you wanted to add to it?

jmcvey3 commented 1 year ago

Currently working on adding turbulence functions to ADCP example notebook

ssolson commented 1 year ago

@jmcvey3 in #236 you said:

@ssolson I just remembered there are some changes in the dolfyn PR (namely to the function/shortcut dolfyn.velocity.U_dir) that will affect this one. I'll try to wrap the dolfyn PR soon here so we can merge these back to back.

So we need to complete this PR first then #236? I am only confused because it seems #236 has passed all tests.

jmcvey3 commented 11 months ago

@ssolson Just pushed some updates to the jupyter notebooks to incorporate the ADCP turbulence analysis.

@jmcvey3 in #236 you said:

@ssolson I just remembered there are some changes in the dolfyn PR (namely to the function/shortcut dolfyn.velocity.U_dir) that will affect this one. I'll try to wrap the dolfyn PR soon here so we can merge these back to back.

So we need to complete this PR first then #236? I am only confused because it seems #236 has passed all tests.

Just to have this on paper, it's a change relevant to the tidal performance jupyter notebook

jmcvey3 commented 11 months ago

@ssolson Just pushed some updates to the jupyter notebooks to incorporate the ADCP turbulence analysis. This PR should be good to go for final review

ssolson commented 11 months ago

@jmcvey3 please ping me when you are ready for me to take a look. On this PR I have https://github.com/jmcvey3/MHKiT-Python/pull/4 open agains your branch for my suggestions for the ipython notebook.

jmcvey3 commented 11 months ago

@ssolson Ready to go! I cleaned up the rest of the docstrings (I think I got everything) and added more checks for function inputs.

ssolson commented 11 months ago

James thank you making all those changes.

Currently the CI/CD has passed all but the hindcast which this PR does not modify. As such I am going to proceed with the merge.

image