Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix hanging Hindcast tests #311

Merged
merged 29 commits into from
Apr 27, 2024
Merged

Conversation

ssolson
Copy link
Contributor

@ssolson ssolson commented Apr 25, 2024

This PR addresses 2 issues with the hindcast tests:

  1. On PRs tests were only being run on changes to hindcast test files.
    • Fixed to run on changes to hindcast test and module files.
  2. The prepare cache job was failing due to 6 hour job limit.
    • Fixed by breaking out each hindcast cache test into its own job.

Additionally this PR updates action packages to the latest version where possible.

ssolson and others added 20 commits August 31, 2023 07:11
@ssolson
Copy link
Contributor Author

ssolson commented Apr 26, 2024

Okay we are for sure hitting a 6 hour limit of the wind tests.

image

Running just the wind_hindcast tests locally it takes 4 hours and 22 minutes. Which is pretty insane amount of time. I think if I break these out into their own jobs I could get 6 hours per job,

image

@ssolson
Copy link
Contributor Author

ssolson commented Apr 26, 2024

Okay great the hindcast jobs now run separate which should fix the 6 hour issue. The new job flow looks as follows:
image

with:
filters: |
wave_io_hindcast:
- 'mhkit/tests/wave/io/hindcast/**'
- 'mhkit/wave/io/hindcast/**'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably check for changes in both places: hindcast tests and the hindcast module itself

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I have been too lazy to investigate if I could just add the test line to the filters. Looks like I can.

I'll push the commit up after the current actions pass or fail.

@ssolson ssolson self-assigned this Apr 26, 2024
@ssolson ssolson added the Clean Up Improve code consistency and readability label Apr 26, 2024
@ssolson
Copy link
Contributor Author

ssolson commented Apr 26, 2024

Okay great new test structure is working. Just need to check these final adjustments to make sure the check changes on multiple file locations and bumping up the versions on the actions works.

@ssolson ssolson marked this pull request as ready for review April 26, 2024 17:00
@ssolson
Copy link
Contributor Author

ssolson commented Apr 26, 2024

@akeeste with the tests now working could you give this a final review/ approval (assuming all tests pass in ~4 hours)?

My goal is to get this into develop today/ this weekend so I can then have these tests pass on #307 over the weekend.

@ssolson ssolson merged commit 184a5ab into MHKiT-Software:develop Apr 27, 2024
20 checks passed
This was referenced Apr 27, 2024
@ssolson ssolson deleted the tests_hang branch May 4, 2024 16:20
This was referenced May 4, 2024
ssolson added a commit that referenced this pull request May 8, 2024
# MHKiT v0.8.0
We're excited to announce the release of MHKiT v0.8.0, which brings a host of new features, enhancements, and bug fixes across various modules, ensuring compatibility with Python 3.10 and 3.11, and introducing full xarray support for more flexible data handling. Significant updates in the Wave and DOLfYN modules improve functionality and extend capabilities.

## Python 3.10 & 3.11 Support
MHKiT now supports python 3.10 and 3.11. Support for 3.12 will follow in the next minor update.
- #240


## Wave Module
### Enhancements:
**Automatic Threshold Calculation for Peaks-Over-Threshold**: We've introduced a new feature that automatically calculates the "best" threshold for identifying significant wave events. This method, originally developed by Neary, V. S., et al. in their 2020 study, has now been translated from Matlab to Python, enhancing our existing peaks-over-threshold functionality.

**Wave Heights Analysis**: A new function, `wave_heights`, has been added to extract the heights of individual waves from a time series. This function uses zero up-crossing analysis to accurately measure wave heights, improving upon our previous methods which only provided the maximum value between up-crossings.

**Enhanced Zero Crossing Analysis**: Building on the above, the zero crossing code previously embedded in `global_peaks` has been isolated into a helper function. This modular approach not only refines the codebase but also supports new functionalities such as calculating wave heights, zero crossing periods, and identifying crests.

### Bug Fixes:
**Contour Sampling Error in Wave Contours**: A bug identified in `mhkit.wave.contours.samples_contour` has been resolved. The issue occurred when period samples defined using the maximum period resulted in values outside the interpolation range of the contour data. This was corrected by ensuring that all sampling points are within the interpolation range and adjusting the contour data selection process accordingly.

- #268 
- #252 
- #278


## Xarray Support
MHKiT functions now fully support the use of xarray for passing and returning data.

- #279 
- #282
- #285
- #302
- #310


## DOLfYN

Thanks to the many user contributions and users of MHKiT the DOLFYN module include a significant number of enhancements and bug fixes. 

### Enhancements:
**Altimeter Support**: Enhanced the Nortek Signature Reader to add capability for reading ADCP dual profile configurations.

**Data Handling Improvements**: Introduced logic to skip messy header data that can accumulate during measurements collected via Nortek software on PCs and Macs.

**Instrument Noise Subtraction**: Added a function to subtract instrument noise from turbulence intensity estimation using RMS calculations, providing results that differ by approximately 1% from the existing standard deviation-based "I" property.

**Improved File Handling**: Updates for RDI files to handle changing "number of cells" and variable "cell sizes," which are now bin-averaged into the largest cell size.

### Bug Fixes:
**Power Spectra Calculation**: Fixed a bug where a given noise value was not being subtracted from the power spectra, and noise was inadvertently added as an input to dissipation rate calculations.

**Improved Header Handling**: Allowed RDI reader to skip junk headers effectively.

**Nortek Reader C Types Update**: Adjusted C types in the Nortek reader to handle below-zero water temperatures and to allow pitch and roll values to go negative.


- #280 
- #289
- #290
- #292
- #293
- #294
- #299


## River & Tidal: D3D
Added limits to `variable_interpolation` and added 3 array input capability to `create_points`
- #271

## Developer Experience
### Black formatting
Black formatting is now enforced on all MHKiT files. This ensures consistent formatting across the MHKiT package.
- #281

### Linting & Type Hints
MHKiT is in the process of enforcing pylint and adding type hints to all functions. Currently this has been achieved and is enforced in the Loads and Power modules.
- #288 
- #296 

### CI/CD
This release introduces significant reduction in testing time for development. This is achieved by reducing the number of tests for pulls against the develop branch and only running hindcast test when changes are made to it. A bug in the hindcast CI was fixed which only ran on changes to the hindcast tests instead of the hindcast module. Additionally the wave and wind hindcast needed to be separated in 2 jobs due to the excessive time taken to run a wind cache. This created a number of follow on PRs around solidifying the logic of these job. A special case for Python 3.8, pip, and Mac OS was added to use homebrew to install NetCDF and HDF5 to get tests to pass.
- #241
- #270
- #306
- #311
- #317
- #318
- #319
- #320
- #324

### Clean Up
MHKiT fixed an implementation error where functions used assert instead of built in errors for type and value checking. Additionally these PRs removed unused files, fixed typos, and created an argument which allows users to run CDIP API calls silently.
- #276
- #272
- #273
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Clean Up Improve code consistency and readability
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants