Add WEC-Sim power performance example #395
Merged
Merged
Conversation
Contributor
|
I’ve tested the WEC-Sim examples with a variety of WEC-Sim cases, including:
Overall, the implementation works well across these scenarios. However, I’ve noticed a few points worth mentioning:
These limitations are not critical for merging but are worth noting for future improvements. Great work on this feature! If my final commit works for you, feel free to merge the PR |
MShabara
reviewed
May 19, 2025
Contributor
Author
|
@MShabara understood on GBM as that has an entirely different output structure.--this can be a separate future PR. On the wave spectrum--where did you see this inconsistency coming in? Is it based in WEC-Sim or MHKiT? |
Contributor
Author
|
Merging this PR as the WEC-Sim example is working as intended. The discrepancies in wave spectra will be addressed in a new issue |
akeeste
added a commit
to akeeste/MHKiT-Python
that referenced
this pull request
Sep 30, 2025
This PR adds an example that uses MHKiT and WEC-Sim together to do a power performance assessment: - utilize resource characterization in PacWave notebook - write MCR cases for WEC-Sim - load WEC performance - assess WEC performance Right now I represent the resource using the 32-cluster results in the PacWave notebook and irregular waves in WEC-Sim. I was considering writing all 2000+ wave cases in that example to a WEC-Sim MCR file so that we can demonstrate `mhkit.wave.performance.power_performance_workflow()` but decided it would be too expensive, even if regular waves were used in WEC-Sim. I also have a half-finished example that shows how to write a directional spectra (like in `directional_waves.ipynb`) for WEC-Sim. But the WEC-Sim 'full directional spectra" feature needs documentation and an example first. The PR also includes a function to make the xarray representation of WEC-Sim data a lot more useful --------- Co-authored-by: Mohamed Shabara <84589678+MShabara@users.noreply.github.com>
Merged
akeeste
added a commit
that referenced
this pull request
Sep 30, 2025
v1.0.0 # MHKiT v1.0.0 ## New Features * Sound Exposure Level by @jmcvey3 in #388 * Add discharge function to MHKiT by @jmcvey3 in #385 ## Functionality enhancements * Fix for corrupted Nortek files by @jmcvey3 in #372 * Update integral length scale function by @jmcvey3 in #376 * Fix ever-changing RDI RiverPro depth bin ranges by @jmcvey3 in #378 * Allow clean functions to handle _avg variables by @jmcvey3 in #377 * IEC TS 62600 updates by @akeeste in #382 * MLER explanation updates/corrections by @rgcoe in #393 * Improve Nortek2 index file creator functions by @jmcvey3 in #397 * Read Sentinel V specific data packets by @jmcvey3 in #396 * Short list of VMDAS updates by @jmcvey3 in #405 * Allow user to specify universal Kolmogorov constant for TKE dissipation rate function by @jmcvey3 in #406 * Nortek Dual Profile Dataset Rotation by @jmcvey3 in #414 ## Source code improvements * Lint Tidal by @ssolson in #386 * Lint river module by @ssolson in #389 * Lint hindcast by @ssolson in #398 * Modernize Package Configuration by @ssolson in #400 * Configure specific warnings by @ssolson in #401 ## Bug fixes * Avoid failing to scan very large files by @jmcvey3 in #371 * Acoustics SPL bugfix by @jmcvey3 in #379 * DOLfYN/RDI: Set `fs` to NaN when typical calculation methods yield error (#408) by @simmsa in #409 ## Testing and Continuous Integration Updates * Fix Jupyter Notebook tests running Python 3.13 by @ssolson in #380 * CI Test Clean Up: Mock USGS, Acoustic Tolerances by @ssolson in #404 * Speed up tests with concurrency checks to prevent duplicate workflows on PRs from develop into main or from main into develop by @akeeste * Define MPLBACKEND to decrease intermittent matplotlib errors in tests by @akeeste ## Documentation and Examples * Add WEC-Sim power performance example by @akeeste in #395 * Update dolfyn function docstrings and associated notebooks by @jmcvey3 in #412 * Update examples by @akeeste in #417 * Update installation instructions in README.md by @akeeste * Adjust acoustics test tolerances by @akeeste in #420 **Full Changelog**: v0.9.0...v1.0.0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an example that uses MHKiT and WEC-Sim together to do a power performance assessment:
Right now I represent the resource using the 32-cluster results in the PacWave notebook and irregular waves in WEC-Sim. I was considering writing all 2000+ wave cases in that example to a WEC-Sim MCR file so that we can demonstrate
mhkit.wave.performance.power_performance_workflow()but decided it would be too expensive, even if regular waves were used in WEC-Sim.I also have a half-finished example that shows how to write a directional spectra (like in
directional_waves.ipynb) for WEC-Sim. But the WEC-Sim 'full directional spectra" feature needs documentation and an example first.The PR also includes a function to make the xarray representation of WEC-Sim data a lot more useful