WDRT parity - Githubissues

MHKiT-Software / MHKiT-MATLAB

MHKiT-MATLAB 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

15 stars 23 forks source link

WDRT parity #127

Closed hivanov-nrel closed 3 days ago

hivanov-nrel commented 2 months ago

This PR is to address MATLAB parity for:

https://github.com/MHKiT-Software/MHKiT-Python/pull/141

Below are the list of functions & tests to be added:

extreme.py:

[x] ste_peaks
[x] block_maxima
[x] ste_block_maxima_gev
[x] ste_block_maxima_gumbel
[x] short_term_extreme
[x] full_seastate_long_term_extreme

peaks.py:

[x] global_peaks
[x] number_of_short_term_peaks
[x] peaks_distribution_weibull
[x] peaks_distribution_weibull_tail_fit
[x] peaks_distribution_peaks_over_threshold

contours.py:

[x] samples_full_seastate
[x] samples_contour

Testing:

[x] add tests
[x] tests are passing locally

Below are list of examples to be added:

[x] extreme_response_contour_example
[x] environmental_contours_example (update outdated function call)
[x] short_term_extreme_example
[x] extreme_response_full_sea_state_example

Below are a list of functions/notebooks not incorporated:

sample.py - return_year_value -> io is a bit complicated
environmental_contours_example -> need to add additional copula methods besides PCA
automatic_hs_threshold -> part of version 0.8.0 which is not yet supported on matlab side

hivanov-nrel commented 3 weeks ago

Hi @simmsa @rpauly18 I think this is ready for review. The code/tests that I worked are passing locally.

The only thing that I am unsure about is that comparing the notebooks to python, there are some instances where the values differ. For instance, the extreme design wave height seems suspiciously low. However, the tests are passing using the same data as python so i'm a bit confused on where the difference can be coming from...