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

Replace asserts with errors, resolves #242 #276

Merged
merged 21 commits into from
Nov 16, 2023

Conversation

akeeste
Copy link
Contributor

@akeeste akeeste commented Nov 7, 2023

This PR replaces all non-testing asserts with code that will raise errors. For the vast majority of asserts, the error messages are unchanged or have additions to say the parameter type or value that was given and is causing an issue.

Some try-except statements appeared like they should be errors, but just defined unused strings. I updated these to throw error messages.

Modules completed:

  • loads
  • power
  • utils
  • tidal
  • dolfyn
  • river/io/d3d
  • river
  • wave/io
  • wave

I left river/io/d3d.py alone for now because #271 edits it and I wanted to avoid conflicts if possible.

Other items

  • @akeeste confirm that the new exceptions being thrown are caught by tests that evaluate incorrect input
  • I also changed a parameter in plot_directional_spectrum. It was using a parameter min that overwrote the built in Python function. i changed the parameter to color_level_min to prevent potential issues.

@akeeste akeeste linked an issue Nov 7, 2023 that may be closed by this pull request
@akeeste akeeste marked this pull request as ready for review November 9, 2023 20:32
@akeeste akeeste requested a review from ssolson November 9, 2023 20:32
@akeeste akeeste added the Clean Up Improve code consistency and readability label Nov 9, 2023
Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

Adam thanks for knocking this out quickly. Couple of comments to address before merging.

mhkit/tidal/resource.py Outdated Show resolved Hide resolved
mhkit/utils/stat_utils.py Outdated Show resolved Hide resolved
mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/wave/io/hindcast/hindcast.py Outdated Show resolved Hide resolved
mhkit/wave/io/ndbc.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/loads/extreme.py Outdated Show resolved Hide resolved
@ssolson
Copy link
Contributor

ssolson commented Nov 15, 2023

@akeeste just checking if this is ready for another review

@akeeste
Copy link
Contributor Author

akeeste commented Nov 15, 2023

@akeeste just checking if this is ready for another review

@ssolson Yes. I implemented all of the suggested changes. Let me know if there's any other changes you'd like to see.

I'm debating if the update to the min parameter of plot_directional_spectrum is necessary. How much of an issue is it to overwrite the python function min? Seems safer to not overwrite it, but the function call won't be backwards compatible then.

@ssolson
Copy link
Contributor

ssolson commented Nov 15, 2023

I'm debating if the update to the min parameter of plot_directional_spectrum is necessary. How much of an issue is it to overwrite the python function min? Seems safer to not overwrite it, but the function call won't be backwards compatible then.

Its a very easy fix for the user to change a kwarg from min to color_bar_min and is the correct way to handle.

Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

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

Adam I found one file where a copy pasta "be" was excluded from multiple exceptions. And I found one place where "If specified" should be added.

I added a note to self about the TODOs but lets not address that here.

After you fix these minor issues above let's merge.

mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/utils/upcrossing.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
mhkit/wave/resource.py Outdated Show resolved Hide resolved
@akeeste
Copy link
Contributor Author

akeeste commented Nov 16, 2023

Thanks @ssolson. I resolved those last few issues and will merge

@akeeste akeeste merged commit 66a9d9b into MHKiT-Software:develop Nov 16, 2023
13 checks passed
@akeeste akeeste deleted the replaceAsserts branch November 16, 2023 20:28
@ssolson ssolson mentioned this pull request Apr 24, 2024
@ssolson ssolson mentioned this pull request May 6, 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
@akeeste akeeste mentioned this pull request May 17, 2024
12 tasks
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.

Assert Statements are for Debugging
2 participants