zijiezhaommhw/m_mhw1.0

A MATLAB toolbox to detect and analyze marine heatwaves (MHWs).

m_mhw1.0's Issues

Non-OSI license

For JOSS review

The license file simply states a name and a year, and does not appear to refer to any from the OSI approved list as required by JOSS.

The use of quantile()

The use of quantile() function in MATLAB raises some errors. Under modifications.

Problems with an_example.m

Undefined function 'datetime' for input arguments of type 'double'.

Error in detect (line 164)
fake_doy = day(datetime(date_false),'dayofyear');

Arrays have incompatible sizes for this operation.

I'm encountering an issue when trying to run the an-example.m code. I'm getting the following error

I'm using MATLAB 23.2 version (R2023b)

No DOIs in paper

For JOSS review

There are no DOIs for citations in the paper or its .bib file; these are required by JOSS.

Update to detect (Adding date_peak and no use of toolbox)

event_line.m seems to only work correctly when data time series starts at the start of the year

The event_line function was incorrectly plotting my MHW events when the time series started in Feb. However when I removed the first year of data so that my time series started on Jan 1st it correctly identified the events. This seems to be a (possibly accidental) deliberate decision and one which should be mentioned in the documentation as I did not see mention of it in there.

Possible solution (??) has now been suggested (#17).

Results inconsistencies with other implementations

For JOSS review

The noted differences in results between the different implementations (MATLAB, Python, R) are worrisome. It's said that this is caused by differences in how the different languages evaluate percentile thresholds, but surely the code could be adapted to enforce consistent calculations? If not, can you demonstrate that this is the only difference between the implementations, and thus prove that no other discrepancies are hiding behind it?

a ‘compound heatwave

Hello
Can this program calculate compound heat waves?
Thank

issue in the mean_and_trend function

I have found two issues in the new code
1_ In the mean_and_trend function, the 1982 should be changed to data_here as not all people used the data from 1982.
2- the output of MHW days is not the same as in the old version.
Thanks

Function inputs documentation

For JOSS review

Documentation on the functions’ API in the readme includes a description of their outputs but nothing on inputs. Inputs are described in code comments within the functions themselves, but it would be helpful to have this info in the readme too.

Matrix dimensions must agree in <= statement

Seems like calculating the climatologies is too advanced for the Matlab 2015a

_Error using <=
Matrix dimensions must agree.

Error in detect (line 179)
m90(:,:,i) = quantile(temp_clim(:,:,any(ind_fake'>=(ind_fake(fake_doy == i)-vWindowHalfWidth) & ind_fake' <=
(ind_fake(fake_doy ==i)+vWindowHalfWidth),2)),vThreshold,3);_

On a Matlab 2020a this error did not appear.

m_map required for testing

For JOSS review

The separate package m_map is required to run the example scripts but no information is provided on how to obtain and install this. Consequently I cannot fully test the functional claims of the software.

m_map is also not listed as a requirement in the documentation. If you consider the example scripts to be not part of the software under review then that could perhaps be justified; m_map is not needed to actually execute the main functions. But as the example scripts are the only straightforward way to test the functionality, I'm not sure that that applies in this case.

Error in evaluating .mat files

I'm trying to focus on MHW in the coastal areas of Greenland. Loaded the "sst" data and saved them as .mat files in the appropriate folder. I get an error:

Error using eval
Undefined function or variable 'sst_2006'.

Here's my code:
`

sst_full=NaN(280,112,datenum(2018,12,31)-datenum(2006,1,1)+1);
for i=2006:2016;
file_here=['sst_' num2str(i)];
load(file_here);
eval(['data_here=sst_' num2str(i) ';'])
sst_full(:,:,(datenum(i,1,1):datenum(i,12,31))-datenum(2006,1,1)+1)=data_here;
end`

Would be grateful to receive some help in this. OR is there another easier code of combining the files?

an_example

Hello! I'm trying to run an_example.m on matlab 2014b
And there is an error:
Error using >=
Matrix dimensions must agree.

Error in detect (line 176)
data_thre=num2cell(temp_clim(:,:,any(ind_fake'>=(ind_fake(fake_doy == i)-vWindowHalfWidth) & ind_fake' <= (ind_fake(fake_doy
==i)+vWindowHalfWidth),2)),3);

Error in an_example (line 28)
[MHW,mclim,m90,mhw_ts]=detect(sst_full,datenum(1982,1,1):datenum(2016,12,31),datenum(1982,1,1),datenum(2005,12,31),datenum(1993,1,1),datenum(2016,12,31));;
%take about 30 seconds.

What it can be?

MATLAB warning flags

For JOSS review

The MATLAB code for the functions themselves contains many warning messages indicating inefficient or unnecessary constructs. I strongly suggest the authors work through and eliminate these, to improve code legibility, and in some cases, its performance.