Version 0.6.0 #162

simmsa · 2025-02-17T21:06:29Z

MHKiT-MATLAB v0.6.0

Release Highlights

Added module and example for upcrossing analysis
Expanded WDRT and extreme wave analysis capability
Expanded DOLFYN functionality with performance optimizations and enhanced visualization
Enhanced MATLAB-Python interoperability with robust type conversion
Added support for MATLAB 2024b, Python 3.10-3.12, and MHKiT-Python v0.9.0
Improved version control capabilities with diffable example formats

Breaking Changes

Removed support for:
- MHKiT-Python versions below v0.9.0
- MATLAB versions 2021b and 2022b
- Python versions 3.8 and 3.9

Impact:

Users must upgrade to MATLAB 2023a or newer
Python environment must use version 3.10-3.12
Users must upgrade to MHKiT-Python v0.9.0 or newer

New Features

Wave Module

Added Upcrossing Analysis Functions and Example (@MShabara) Adds the upcrossing analysis functions in MATLAB #151
- Enables time-series analysis of wave heights and periods using upcrossing methods
- Documentation: Upcrossing Analysis
Enhanced Environmental Contours (@hivanov-nrel) WDRT parity - continued #147
- Added support for IFORM and direct sampling methods
- Improved extreme condition analysis capabilities
- See examples in environmental_contours_example.mlx

DOLFYN Module

Enhanced Data Processing (@simmsa) DOLfYN: Add dimensional averaging, current speed/direction calculations, and enhance ADCP example #141
- Added statistical functions:
  - Dimensional averaging [5b6d20a]
  - Speed and velocity calculations [8ad973b]
  - Time series analysis capabilities
- Performance Optimizations:
  - Added caching for improved read_signature speed [85bf6e0]
  - Enhanced NetCDF attribute handling
- Expanded visualization capabilities [8e4d81d]:
  - New subplot functionality
  - Custom colormaps similar to matplotlib (viridis, bluewhitered)
  - Histogram generation
  - Improved attribute visualization and customization
- New comprehensive ADCP example in adcp_example.mlx

Technical Improvements

Compatibility

Added official support for MATLAB 2024b
Added support for MHKiT-Python v0.9.0 (@simmsa) Add MHKiT-Python v0.9.0 Support #149
- Compatible with Python 3.10-3.12
- Enhanced type conversion system between MATLAB and Python

MATLAB-Python Interoperability

Added robust type conversion system:
- New typecast_spectra_to_mhkit_python: Standardizes spectra data sent to Python
- New typecast_from_mhkit_python: Standardizes Python output for MATLAB
  - Returns consistent struct format:
    - data: Native MATLAB type (scalar, array, or struct)
    - type: Data classification
    - index: Index information
  - Supports:
    - Scalar values
    - Python/NumPy arrays
    - pandas DataFrame/Series

Version Control Improvements

Added Diffable Examples (@simmsa) Examples: Verify and rebuild examples with latest MHKiT-MATLAB #157
- MATLAB Markup (.m) versions of examples for better version tracking
- Maintains Livescript functionality while enabling git-based collaboration
- Improves documentation clarity and maintainability

New Examples

Strain Analysis Example (@simmsa, @akeeste) Add Strain Example from MHKiT-Python #156
- Demonstrates structural load analysis techniques
- Shows data processing workflow for strain measurements
- Includes practical visualizations and analysis methods
Upcrossing Analysis Example (@MShabara) Adds the upcrossing analysis functions in MATLAB #151
- Shows wave height and period analysis workflow
- Includes practical applications of statistical methods
ADCP Data Processing Example (@simmsa) DOLfYN: Add dimensional averaging, current speed/direction calculations, and enhance ADCP example #141
- Illustrates acoustic doppler current profiler data analysis
- Demonstrates new DOLFYN visualization capabilities
- Includes comprehensive processing workflow

Bug Fixes

Fixed WPTO hindcast download issue specific to omni-directional_wave_power [8284aa2]
- Issue #143
- Fixed in PR #144
- Improved robustness and clarity of hindcast downloads
Corrected time scale representation in short-term extremes example (@MShabara) [Fixes bugs with the short_term_extremes_example.mlx #150, 3acf336]
Fixed Delft3D masked array type conversion issues [2a290e5]
Enhanced NetCDF attribute handling and extraction [f63002d]

Dependencies

MATLAB ≥ 2023a
MHKiT-Python ≥ v0.9.0
Python 3.10-3.12

Contributors

Special thanks to all contributors who made this release possible:

* fixes bugs with the short_term_extremes_example * Updates the HTML file

Uses MATLAB's Markup syntax (similar to Markdown) to create a Livescript example in .m format. This format allows version control diffability while maintaining Livescript functionality when opened in MATLAB. The Markup specification is documented here: https://www.mathworks.com/help/matlab/matlab_prog/marking-up-matlab-comments-for-publishing.html. This approach is forward-compatible with MATLAB R2024b's new plain text format for Live Scripts: https://www.mathworks.com/help/matlab/matlab_env/beta-new-desktop-for-matlab.html To hedge against MATLAB removing support for Markup it is also recommended to generate the `.mlx` and `html` files.

Removed in MHKiT Python v0.8.0 and above

Prepare v0.6.0 Release

Hotfix v0.6.0 Build and Release Action

Hotfix: Restrict Development Builds to Contributor Only

At this time the web urls do not work as links. I do not see a specification here: https://www.mathworks.com/help/matlab/ref/matlab.addons.toolbox.toolboxoptions.html I tried: `<https://mhkit-software.github.io/MHKiT/api.html>` `<a href='https://mhkit-software.github.io/MHKiT/api.html'>MATLAB API</a>` `<a href='https://mhkit-software.github.io/MHKiT/api.html'>MATLAB API</a>`

Fix: MHKiT-MATLAB Toolbox Details

Release: update v0.6.0 Toolbox binary and Project file

rpauly18

Good to go once tests finish

hivanov-nrel and others added 30 commits December 31, 2024 16:06

cleanup tests for env contours functions

149b61b

Fix time scale in short_term_extremes_example (#150)

3acf336

* fixes bugs with the short_term_extremes_example * Updates the HTML file

Examples: Add strain example data

68cb076

Example: Add strain example images

e4b9dbd

Examples: Add rendered strain examples

3e6cf0c

Fix: Incorrectly named introduction images

2ea0123

Examples: Reference strain data csv file location

413882a

Examples: Add back experimental description

e08bf3f

Examples: Use a more clear variable name for scale factor

e67c9be

Examples: Ensure titles are formatted correctly

da05cae

Examples: Add visualization of original measurement

be67fb5

Examples: Build strain example output docs

d8ba5b5

Feat: Initial version of matlab/python type standardization

0ca3fbc

Feat: Add function to sanitize fieldnames from raw string

ff203f8

Actions: Improve windows action readability

0d590e4

Clean: Remove unnecessary python imports

d399c3b

Clean: Remove unnecessary python imports

1032515

Fix: Remove unused rated_current argument

50bac55

Removed in MHKiT Python v0.8.0 and above

Tests: Specify rectwin arg as an int

48f6156

Tests: Improve readability

2d1a5fd

Tests: Remove deprecated test_bretschneider_spectrum

2a2b4e3

Wave: Use typecast_spectra_to_mhkit_python

4a6aea9

Tests: Temporarily disable hindcast testing

a84053a

Fix: Plot spectrum should calculate peak period

15c973f

Wave: Use typecasting to extract python spectrum output

07f509a

Wave: Typecast capture_length python output

575fe2e

Wave: Typecast capture_length_matrix output

0fcfe80

Wave: Simplify MAEP type conversion

19f6893

Wave: Iterate over spectra explicitly

aeee104

simmsa and others added 24 commits February 17, 2025 06:29

Fix: Issue #145 Remove TestTags

7c282c6

Build: Upload mhkit_python_utils zip folder as artifact

e3739dc

Build: Add sha to zip filenames

0f0084e

Build: Use correct syntax for github sha accessor

24971a1

Merge pull request #158 from simmsa/prep-v0.6.0-release

31e30e1

Prepare v0.6.0 Release

Build: Rename build job

c533679

Build: Temporarily enable this branch

b02f88b

Build: Validate release version numbers match and increment

584d035

Build: Use short sha for dev artifact files

590aadf

Build: Always check for version number change.

4ae4904

Build: Temp enable release of this branch

dfdde6e

Build: Fix typo

ecc9afb

Build: Define SHORT_SHA to keep code DRY

a85b039

Build: Remove v from __init__.py version number

bb94c1d

Build: Check version number integrity before installing MATLAB

40a91ad

Build: Specify required tag for develop pre-releases

ecaccaf

Merge pull request #159 from simmsa/hotfix-v0.6.0-release-action

0e622ac

Hotfix v0.6.0 Build and Release Action

Build: Restrict development builds to contributor-only visibility

fcab3fb

Build: Use more descriptive init_py variable name

3aae768

Build: Remove custom hotfix branch

1b9baef

Merge pull request #160 from simmsa/hotfix-set-PR-releases-as-draft

15098f9

Hotfix: Restrict Development Builds to Contributor Only

Toolbox: Add mhkit_logo asset

2092872

Merge pull request #161 from simmsa/hotfix-mtlbx-bugs

359ce6a

Fix: MHKiT-MATLAB Toolbox Details

simmsa marked this pull request as ready for review February 17, 2025 21:06

simmsa requested a review from rpauly18 February 17, 2025 21:06

simmsa and others added 2 commits February 17, 2025 14:28

Release: update v0.6.0 Toolbox binary and Project file

1e7df57

Merge pull request #163 from simmsa/hotfix-update-toolbox-binary

2be1910

Release: update v0.6.0 Toolbox binary and Project file

rpauly18 approved these changes Feb 17, 2025

View reviewed changes

simmsa merged commit 55921ca into master Feb 18, 2025
93 of 95 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version 0.6.0 #162

Version 0.6.0 #162

simmsa commented Feb 17, 2025

rpauly18 left a comment

Version 0.6.0 #162

Version 0.6.0 #162

Conversation

simmsa commented Feb 17, 2025

MHKiT-MATLAB v0.6.0

Release Highlights

Breaking Changes

New Features

Wave Module

DOLFYN Module

Technical Improvements

Compatibility

MATLAB-Python Interoperability

Version Control Improvements

New Examples

Bug Fixes

Dependencies

Contributors

rpauly18 left a comment

Choose a reason for hiding this comment