search

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

Updating .mtbx file and README #19

Closed rpauly18 closed 4 years ago

rpauly18 commented 4 years ago

v0.2.0 MHKiT-MATLAB toolbox updated README information

rpauly18 commented 4 years ago

@kmruehl I believe I have caught the terminology and descriptions that need to be updated. Can you take a look and make sure I did not miss anything?

kmruehl commented 4 years ago

@rpauly18 sure, I'll take a look and amend this PR if I see anything. Once merged we can update the mhkit-matlab submodule and recompile the doc.

rpauly18 commented 4 years ago

@rpauly18 this looks good to go. All variables have been changed. I only had a few comments, which I included inline.

Also, do you plan to add unwrap_vector, matlab_to_datetime and index_to_datetime?

I had not planned to wrap unwrap_vector because MATLAB has a function called wrapTo360 that as far as I can tell does the same thing. I believe this util function is called upon from some of Sterling's functions, but I am not sure if wrapping this one is necessary.

Similarly, I am not sure the Matlab_to_datetime needs to be wrapped because each function wrapper handles grttingthe time into an acceptable format for MHKiT-Python.

Lastly, is index_to_datetime still in the utils module? I do not see it.

Let me know if you disagree with any of this.

kmruehl commented 4 years ago

@rpauly18

index_to_datetime is imported from Pecos, so while it is not included in the MHKiT-Python source, it is included in the distribution.

I don't see unwrap_vector called anywhere in MHKiT. However, wrapTo360 does appear to have the same functionality.

Matlab_to_datetime sounds reasonable to me.

Perhaps it's worth referring users to builtin MATLAB functions when appropriate in the documentation?

kmruehl commented 4 years ago

@rpauly18 one last comment. Where did the power_example.mlx file go? It's not in this PR or on master.