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

Introduce upcrossing analysis module #252

Closed mbruggs closed 8 months ago

mbruggs commented 11 months ago

As disussed in #230, there were no general methods for performing an upcrossing analysis. This series of commits introduces such a module and uses it to implement the existing functionality within the loads.extreme.global_peaks function.

mbruggs commented 11 months ago

Hello! Thanks as always for all the work on MHKit!

I wasn't sure exactly where to put this new functionality as it doesn't nicely sit within any of the existing modules. I opted for the qc module as it seems the most generic. Happy to move if you think there's somewhere better :)

mbruggs commented 11 months ago

It looks like the check below hasn't passed it dosen't seem to be related to my change:

Py 3.7 3.8, 3.9 | Windows Mac Linux / pip-windows-latest/3.9 (pull_request)

ssolson commented 11 months ago

It looks like the check below hasn't passed it dosen't seem to be related to my change:

Py 3.7 3.8, 3.9 | Windows Mac Linux / pip-windows-latest/3.9 (pull_request)

Mark No worries and thank you. There are API issues that are being addressed in #241 .

mbruggs commented 8 months ago

Thanks for the review @akeeste! I made a comment that's hopefully quick to resolve in mbruggs#2.

I agree the location of this functionality is a bit tricky. I'm more than happy for it go into loads - my hesitation was that the methods are equally applicable to wave analysis.

akeeste commented 8 months ago

@mbruggs That's a good point. Sterling and I discussed location today and decided this is probably best under mhkit.utils, since it is applicable to both loads, wave data and really could be applied to any other timeseries data of interest. I'll update that in mbruggs#2 this week

akeeste commented 8 months ago

Apologies about all the sporadic final commits. I missed a few things when moving the upcrossing module. Tests are now passing. Merging this PR. Thanks @mbruggs!

mbruggs commented 7 months ago

@akeeste Thanks very much for all your work on this!