Merge pull request #181 from simmsa/prep_v1.0_release

Prep v1.0 release

Author: simmsa

.github/workflows/unix_unit_tests.yml

@@ -1,10 +1,19 @@
 name: MHKiT-MATLAB Unix Unit Tests
 
+# Only run tests when MATLAB files or this workflow file changes
 on:
   push:
     branches: [ master, develop ]
+    paths:
+      - 'mhkit/**/*.m'
+      - 'examples/**/*.m'
+      - '.github/workflows/unix_unit_tests.yml'
   pull_request:
     branches: [ master, develop ]
+    paths:
+      - 'mhkit/**/*.m'
+      - 'examples/**/*.m'
+      - '.github/workflows/unix_unit_tests.yml'
 
 jobs:
   cache_population:

.github/workflows/windows_unit_tests.yml

@@ -1,10 +1,19 @@
 name: MHKiT-MATLAB Windows Unit Tests
 
+# Only run tests when MATLAB files or this workflow file changes
 on:
   push:
     branches: [ master, develop ]
+    paths:
+      - 'mhkit/**/*.m'
+      - 'examples/**/*.m'
+      - '.github/workflows/windows_unit_tests.yml'
   pull_request:
     branches: [ master, develop ]
+    paths:
+      - 'mhkit/**/*.m'
+      - 'examples/**/*.m'
+      - '.github/workflows/windows_unit_tests.yml'
 
 jobs:
   cache_population:

changelog.md

@@ -1,4 +1,21 @@
-# Current development
+# 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, @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
 
@@ -21,6 +38,13 @@
   - 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, @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 170 - WDRT leftovers
 
 - Author: @hivanov-nrel
@@ -31,6 +55,14 @@
 - Author: @simmsa
 - Fix code compatibility issues detailed in issues #115, #116, #117, #118, #119, #120, #121, and #122
 
+## Bug Fixes
+
+- Issue #172 - Fix Failing MLER Test - @hivanov-nrel
+- Issue #152 - Fix dimensionality differences in environmental_contours_example - @simmsa
+- Issue #146, #74 - Finish WDRT Parity - @hivanov-nrel
+- Issue #145 - Fix build errors in documentation - @simmsa
+- Issue #114, #115, #116, #117, #118, #119, #121, #122 - MATLAB code compatibility issues
+
 # MHKiT-MATLAB v0.6.0
 
 ## Release Highlights

mhkit/tests/Wave_TestIO.m

@@ -111,7 +111,7 @@ function test_swan_read_block(testCase)
         % WPTO multiple locations
         function test_WPTO_point_multiloc(testCase)
 
-            assumeFail(testCase, "API key usage saturated - temporarily disabling")
+            % assumeFail(testCase, "API key usage saturated - temporarily disabling")
             % Error using matlab.internal.webservices.HTTPConnector/copyContentToByteArray (line 373)
             % The server returned the status 503 with message "Service Unavailable" in response to the request to URL
             % https://developer.nrel.gov/api/hsds/?api_key=3K3JQbjZmWctY0xmIfSYvYgtIcM3CN0cb1Y2w9bf&domain=%2Fnrel%2FUS_wave%2Fvirtual_buoy%2FWest_Coast%2FWest_Coast_virtual_buoy_2010.h5.
@@ -147,7 +147,7 @@ function test_WPTO_point_multiloc(testCase)
 
         function test_WPTO_omnidirectional(testCase)
 
-            assumeFail(testCase, "API key usage saturated - temporarily disabling")
+            % assumeFail(testCase, "API key usage saturated - temporarily disabling")
 
             api_key = '3K3JQbjZmWctY0xmIfSYvYgtIcM3CN0cb1Y2w9bf';
             hindcast_data = request_wpto('1-hour',...
@@ -178,7 +178,7 @@ function test_WPTO_omnidirectional(testCase)
 
         function test_WPTO_point_multiparm(testCase)
 
-            assumeFail(testCase, "API key usage saturated - temporarily disabling")
+            % assumeFail(testCase, "API key usage saturated - temporarily disabling")
 
             api_key = '3K3JQbjZmWctY0xmIfSYvYgtIcM3CN0cb1Y2w9bf';
             hindcast_data = request_wpto('3-hour',...

mhkit_python_utils/__init__.py

@@ -6,7 +6,7 @@
 
 _warn.simplefilter(action="ignore", category=FutureWarning)
 
-__version__ = "0.7.0-dev.2"
+__version__ = "1.0.0"
 
 __copyright__ = """
 Copyright 2019, Alliance for Sustainable Energy, LLC under the terms of 

pyproject.toml

@@ -9,7 +9,7 @@ name = "mhkit_python_utils"
 # Non Release version format:
 #   - <Next Major (opt)>.<Next Minor>.Patch-<label>.Build, i.e., 0.7.0-dev.1
 #   - Labels can be 'dev', 'alpha', 'beta', 'rc' (release candidate)
-version = "0.7.0-dev.2"
+version = "1.0.0"
 description = "A utility package that enables data exchange and interoperability between MHKiT-MATLAB and MHKiT-Python. Part of the MHKiT (Marine and Hydrokinetic Toolkit) project."
 readme = "README.md"
 requires-python = ">=3.10"

scripts/build_release.m

@@ -18,7 +18,7 @@
 %   7 indicates a beta version
 %   6 indicates a release candidate version
 % i.e.: Development build for version 0.7.0-dev.2 would be 0.7.0.9002
-project_version = '0.7.0.9002';
+project_version = '1.0.0';
 matlab_minimum_release_supported = 'R2022b';
 summary = 'Marine energy data analysis and visualization toolbox';
 description = sprintf([ ...