Skip to content
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.

Sign up for GitHub

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

WDRT parity - continued #147

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

WDRT parity - continued #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
988468a
add contours and update example
hivanov-nrel Nov 26, 2024
d2185cd
cleanup tests for env contours functions
hivanov-nrel Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified examples/environmental_contours_example.mlx
View file
Open in desktop
Binary file not shown.
21 changes: 11 additions & 10 deletions mhkit/tests/Wave_TestResourceMetrics.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ function test_plot_elevation_timeseries(testCase)

function test_environmental_contour(testCase)

assumeFail(testCase, "Not compatible with latest MHKIT-Python")
% assumeFail(testCase, "Not compatible with latest MHKIT-Python")

relative_file_name= '../../examples/data/wave/Hm0_Te_46022.json';
full_file_name = fullfile(fileparts(mfilename('fullpath')), relative_file_name);
Expand Down Expand Up @@ -319,24 +319,24 @@ function test_environmental_contour(testCase)
dt = (time2-time1)/1000.;
time_R = 100;

contour = environmental_contour(Hm0, Te, dt, time_R);
contour = environmental_contours(Hm0, Te, dt, time_R, 'PCA');

relative_file_name= '../../examples/data/wave/Hm0_Te_contours_46022.csv';
full_file_name = fullfile(fileparts(mfilename('fullpath')), relative_file_name);
expected_contours = readmatrix(full_file_name);

Hm0_expected = expected_contours(:,2);
Te_expected = expected_contours(:,1);
Hm0_expected = expected_contours(:,1);
Te_expected = expected_contours(:,2);

assertEqual(testCase,table2array(contour.contour2),Hm0_expected,'RelTol',0.01);
assertEqual(testCase,table2array(contour.contour1),Te_expected,'RelTol',0.01);
assertEqual(testCase,contour.contour1,Hm0_expected','RelTol',0.01);
assertEqual(testCase,contour.contour2,Te_expected','RelTol',0.01);


end

function test_plot_environmental_contour(testCase)

assumeFail(testCase, "Not compatible with latest MHKIT-Python")
%assumeFail(testCase, "Not compatible with latest MHKIT-Python")

relative_file_name= '../../examples/data/wave/Hm0_Te_46022.json';
full_file_name = fullfile(fileparts(mfilename('fullpath')), relative_file_name);
Expand Down Expand Up @@ -369,7 +369,7 @@ function test_plot_environmental_contour(testCase)
dt = (time2-time1)/1000.;
time_R = 100;

contour = environmental_contour(Hm0, Te, dt, time_R);
contour = environmental_contours(Hm0, Te, dt, time_R, 'PCA');

filename = 'wave_plot_env_contour.png';
if isfile(filename)
Expand All @@ -388,7 +388,8 @@ function test_plot_environmental_contour(testCase)
function test_plot_environmental_contour_multiyear(testCase)

assumeFail(testCase, "Not compatible with latest MHKIT-Python")

% not sure about why this test exists...return period has to be float or
% int and cannot be a list...
relative_file_name= '../../examples/data/wave/Hm0_Te_46022.json';
full_file_name = fullfile(fileparts(mfilename('fullpath')), relative_file_name);

Expand Down Expand Up @@ -420,7 +421,7 @@ function test_plot_environmental_contour_multiyear(testCase)
dt = (time2-time1)/1000.;
time_R = [100, 120, 130];

contour = environmental_contour(Hm0, Te, dt, time_R);
contour = environmental_contours(Hm0, Te, dt, time_R, 'PCA');

filename = 'wave_plot_env_contour_multiyear.png';
if isfile(filename)
Expand Down
74 changes: 53 additions & 21 deletions mhkit/wave/resource/environmental_contours.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,45 @@
% Desired return period (years) for calculation of environmental
% contour, can be a scalar or a vector.
%
% PCA: Structure (optional)
% principal component analysis dictionary from previous function
% call. When supplied the function will skip the PCA calculation
% for the passe x1, and x2.
% to call: environmental_contour(x1,x2,dt,period,"PCA",PCA)
% method: string or list
% Copula method to apply. Options include ['PCA','gaussian',
% 'gumbel', 'clayton', 'rosenblatt', 'nonparametric_gaussian',
% 'nonparametric_clayton', 'nonparametric_gumbel', 'bivariate_KDE'
% 'bivariate_KDE_log']
%
% bin_size : double (optional)
% Data points in each bin
% to call: environmental_contour(x1,x2,dt,period,"bin_size",bin_size)
%
% nb_steps : int (optional)
% Discretization of the circle in the normal space used for
% IFORM calculation.
% to call: environmental_contour(x1,x2,dt,period,"nb_steps",nb_steps)
%
% return_PCA: boolean
% Default False, if True will retun the PCA dictionary
% to call: environmental_contour(x1,x2,dt,period,"return_PCA",return_PCA)
% **OPTIONS
% min_bin_count: int
% Passed to _copula_parameters to sets the minimum number of
% bins allowed. Default = 40.
% initial_bin_max_val: int, double
% Passed to _copula_parameters to set the max value of the
% first bin. Default = 1.
% bin_val_size: int, double
% Passed to _copula_parameters to set the size of each bin
% after the initial bin. Default 0.25.
% nb_steps: int
% Discretization of the circle in the normal space is used for
% copula component calculation. Default nb_steps=1000.
% bandwidth:
% Must specify bandwidth for bivariate KDE method.
% Default = None.
% Ndata_bivariate_KDE: int
% Must specify bivariate KDE method. Defines the contoured
% space from which samples are taken. Default = 100.
% max_x1: double
% Defines the max value of x1 to discretize the KDE space
% max_x2: double
% Defines the max value of x2 to discretize the KDE space
% PCA: dict
% If provided, the principal component analysis (PCA) on x1,
% x2 is skipped. The PCA will be the same for a given x1, x2
% therefore this step may be skipped if multiple calls to
% environmental contours are made for the same x1, x2 pair.
% The PCA dict may be obtained by setting return_fit=True when
% calling the PCA method.
% return_fit: boolean
% Will return fitting parameters used for each method passed.
% Default False.
%
%
% Returns
Expand All @@ -68,9 +89,16 @@
dt
period
method
options.PCA = py.None;
options.bin_size = 250;
options.min_bin_count = 40;
options.initial_bin_max_val = 1;
options.bin_val_size = 0.25;
options.nb_steps = 1000;
options.bandwidth = py.None;
options.Ndata_bivariate_KDE = 100;
options.max_x1 = py.None;
options.max_x2 = py.None;
options.PCA = py.None;
options.PCA_bin_size = 250;
options.return_fit = py.False;
end

Expand All @@ -90,8 +118,12 @@
end

data = py.mhkit.wave.contours.environmental_contours(py.numpy.array(x1),py.numpy.array(x2),...
int32(dt),period_py,method,pyargs('PCA',options.PCA,'bin_size',int32(options.bin_size),...
'nb_steps',int32(options.nb_steps),'return_fit',options.return_fit));
int32(dt),period_py,method,pyargs('min_bin_count',int32(options.min_bin_count),...
'initial_bin_max_val',options.initial_bin_max_val,'bin_val_size',options.bin_val_size,...
'nb_steps',int32(options.nb_steps),'bandwidth',options.bandwidth,...
'Ndata_bivariate_KDE',options.Ndata_bivariate_KDE,'max_x1',options.max_x1,...
'max_x2',options.max_x2,'PCA',options.PCA,'PCA_bin_size',int32(options.PCA_bin_size),...
'return_fit',options.return_fit));

data_struct = struct(data);

Expand Down
Loading