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

Package Requirements & Python version 10, 11 #240

Merged
merged 34 commits into from
Oct 30, 2023

Conversation

ssolson
Copy link
Contributor

@ssolson ssolson commented May 11, 2023

This PR adds testing support for Python 3.10 and 3.11 and removes all upper bound on required package versions such that users can work with the newest versions of all required packages.

Additionally this PR will now only run on ubuntu on pulls to develop and will run windows, macOS, and ubuntu on pulls to master. This reduces runtime by ~15 minutes for development PRs. To make this work a new job was added set-os which sets the os matrix based on which branch the PR is made against.

Most changes did not require changing the module source code. To update to the latest pandas:

  • mhkit.power.quality: change deprecated get_loc to get_indexer (docs)

image

@ssolson ssolson changed the base branch from master to develop May 11, 2023 14:12
@ssolson ssolson self-assigned this May 11, 2023
@ssolson ssolson added the Clean Up Improve code consistency and readability label May 11, 2023
@ssolson ssolson linked an issue May 11, 2023 that may be closed by this pull request
@akeeste akeeste self-requested a review May 11, 2023 18:42
@ssolson
Copy link
Contributor Author

ssolson commented Oct 17, 2023

Pecos has merged a fix to master causing the error seen in the current build. Specifically the error is from pandas index method deprecation which replaced is_montonic with is_monotinic_increasing (or decreasing) and will soon release an update to pypi which will allow MHKiT to pass tests with the most recent pandas version.

sandialabs/pecos#76

@ssolson ssolson changed the title Update MHKiT Package Requirements MHKiT Package Requirements & Python version 10, 11 Oct 18, 2023
@ssolson ssolson changed the title MHKiT Package Requirements & Python version 10, 11 Package Requirements & Python version 10, 11 Oct 18, 2023
@ssolson ssolson marked this pull request as ready for review October 23, 2023 17:36
@ssolson
Copy link
Contributor Author

ssolson commented Oct 23, 2023

@akeeste this PR is ready for review.

One discussion point I would suggest adding would be to only test ubuntu on pulls to the dev branch and then test windows and mac on pull to the master branch. Doing so would reduce testing time from ~30 minutes to ~15 minutes.

image

Would you be opposed or have any concerns with this testing setup?

Copy link
Contributor

@akeeste akeeste left a comment

Choose a reason for hiding this comment

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

@ssolson Thanks for these updates!

Multiple OS increasing the test time has recently been an issue for WEC-Sim too. I support only running Mac and Windows for changes to master. It's worth a try to speed-up development time.

A couple requests:

  • Update the job name to reflect the new python versions being test
  • Update the hindcast-calls jobs to mirror either the pip-build or conda-build? Now that the check-changes and prepare-cache jobs are in place, it shouldn't add a lot of test time to keep it consistent with the other main jobs.

I'm open to discussion here on the hindcasts since it's been such a big issue lately

@ssolson ssolson requested a review from akeeste October 27, 2023 16:50
@ssolson
Copy link
Contributor Author

ssolson commented Oct 27, 2023

@akeeste I believe I have addressed your changes as well as added the only ubuntu on pulls to develop. Please, give it a review and lmk what you think.

@ssolson ssolson merged commit e89deab into MHKiT-Software:develop Oct 30, 2023
13 checks passed
@ssolson ssolson mentioned this pull request Dec 18, 2023
@ssolson ssolson deleted the packages branch April 16, 2024 14:55
@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
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.

Allow newer xarray versions?
2 participants