Prep v1.0 release

[simmsa]

Version 1.0.0

Release Highlights

• New acoustics, and mooring modules
• Improvements to Wave, WDRT, and DOLFYN modules
• New examples for acoustics, mooring, and WEC-sim, and improved examples for DOLFYN and wave modules
• Multiple bug fixes and performance improvements

PR #174 - Acoustics Module

• Authors: @hivanov-nrel
• Reviewer: @simmsa
• Addition of acoustics module:
  • Reading and standardization of of OceanSonics icListen and OceanInstruments Soundtrap hydrophone files
  • Implementation of numerical computation sections IEC 62600-40 "Acoustic characterization of marine energy converters" standard
  • Spectrogram data visualizations using plot_spectrogram
  • Sound exposure level calculations with auditory weighting functions for 5 groups of marine mammals
  • Complete example livescript in examples/acoustics_example.mlx

PR #176 - Wave Module Native MATLAB Implementation

• Authors: @MShabara
• Reviewer: @simmsa
• Convert wave module functions to native MATLAB code:
  • wave/resource/standardize_wave_spectra_frequency.m:
  • wave/resource/frequency_moment.m:
  • wave/resource/energy_period.m:
  • wave/resource/significant_wave_height.m:
  • wave/resource/jonswap_spectrum.m:
  • wave/resource/pierson_moskowitz_spectrum.m:
  • wave/resource/surface_elevation.m:

PR #153 - Mooring Module

• Author: @hivanov-nrel
• Reviewer: @simmsa
• Addition of the mooring module, which includes
  • Read in MoorDyn files into MATLAB
  • Function to calculate mooring line lay length
  • Functions to visualize mooring line dynamics in 2D or 3D.
  • Example LiveScript demonstrating the functionality of the mooring module

PR #173 - Dolfyn Turbulence Functionality

• Author: @simmsa
• Reviewer: @browniea
• Addition of turbulence calculations for acoustic doppler instruments
  • Turbulence intensity, noise, and reynolds stress calculations
  • Updates to examples/adcp_example.mlx live script

PR #175 - WEC-Sim Power Performance Example

• Author: @akeeste
• Reviewer: @simmsa
• Addition of examples/wecsim_example.mlx
  • Analysis of WEC-Sim output mat file using MHKiT
  • Leverage MHKiT wave module to calculate spectra and statistics on surface elevation

PR #170 - WDRT Final Tasks

• Author: @hivanov-nrel
• Reviewer: @simmsa
• Expanded WDRT functionality by adding automatic_hs_threshold and return_year_value functions

PR #169 - Code Compatibility Improvements

• Author: @simmsa
• Reviewer: @hivanov-nrel
• Fix code compatibility issues detailed in issues Code Compatibility: DATNM Info #115, Code Compatibility: DATST Info #116, Code Compatibility: DISPPROG #117, Code Compatibility: GETFMT #118, Code Compatibility: HISTC #119, Code Compatibility: IDISVARLOW #120, Code Compatibility: LEGPVPAIR #121, and Code Compatibility: VERLESSMATLAB #122

Bug Fixes

• Issue Loads: mler_coefficients phase calculation has wrong sign (negative instead of positive) #172 - Fix Failing MLER Test - @hivanov-nrel
• Issue Bug in environmental_contours_example.mlx due to spectra_to_pandas return variable #152 - Fix dimensionality differences in environmental_contours_example - @simmsa
• Issue WDRT parity - continued #146, WDRT Functionality  #74 - Finish WDRT Parity - @hivanov-nrel
• Issue Docs build errors #145 - Fix build errors in documentation - @simmsa
• Issue Code Compatibility: COLMP Warnings #114, Code Compatibility: DATNM Info #115, Code Compatibility: DATST Info #116, Code Compatibility: DISPPROG #117, Code Compatibility: GETFMT #118, Code Compatibility: HISTC #119, Code Compatibility: LEGPVPAIR #121, Code Compatibility: VERLESSMATLAB #122 - MATLAB code compatibility issues

[hivanov-nrel]

Looks good to me. I had a more extensive summary of the acoustics module changelog in the PR, but if we are going for briefness, this works!

[simmsa]

@hivanov-nrel good call. I'm gonna keep the release notes relatively succinct, but I will add this to the changelog:

Acoustics Module

• Introduced a new Acoustics module to MHKiT, providing comprehensive tools for processing and analyzing passive acoustic data from hydrophone recordings.
• Designed to facilitate compliance with the IEC-TS 62600-40 standard
• Supports hydrophone models such as SoundTrap and icListen, with functionality to read, calibrate, and process hydrophone data into acoustic metrics.
• Includes functionalities for:
  • Reading hydrophone data.
  • Performing spectral analyses.
    • spectral density (SPSD)
    • spectral density levels (SPSDL)
    • fractional octave bands (e.g., third-octave, decidecade)
    • Sound Pressure Level (SPL)
  • Applying calibrations.
  • Calculating sound pressure levels.
  • Visualizing results.

To support users, an example notebook demonstrates the application of this module with workflows