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

Examples: Verify and rebuild examples with latest MHKiT-MATLAB #157

Merged
merged 79 commits into from
Feb 15, 2025

Conversation

simmsa
Copy link
Contributor

@simmsa simmsa commented Feb 14, 2025

Overview

This PR verifies and rebuilds all existing MHKiT-MATLAB examples with the latest version of the toolbox. The work includes:

  • Verifying correct operation of all examples with latest MHKiT-MATLAB
  • Standardizing data paths and file handling across examples
  • Improving code formatting, whitespace, and fixing typos
  • Enhancing visualizations with consistent sizing and improved styling
  • Verifying key functionality (data downloads, filtering, toolbox dependencies)
  • Rebuilding LiveScript and HTML documentation for all examples

These updates ensure all examples remain current and functional with the latest MHKiT-MATLAB release.

Example File Conversion and Verification Status

CDIP Example (cdip_example)

  • Convert to .m
  • Fix typos and whitespace
  • Build livescript and HTML

Delft3D Example (delft3d_example)

  • Convert to .m
  • Fix typos and whitespace
  • Build livescript and HTML

Environmental Contours Example (environmental_contours_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Verify operation (data filtering, field passing)
  • Set plot sizes
  • Build livescript and HTML

Extreme Response Contour Example (extreme_response_contour_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Verify operation (data query)
  • Set figure sizes
  • Build livescript and HTML

Extreme Response Full Sea State Example (extreme_response_full_sea_state_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Verify operation (download and filtering)
  • Set figure sizes
  • Build livescript and HTML

Extreme Response MLER Example (extreme_response_MLER_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Verify operation (RAO, coefficients)
  • Set plot sizes
  • Build livescript and HTML

Loads Example (loads_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Standardize data paths
  • Build livescript and HTML

Power Example (power_example)

  • Convert to .m
  • Fix whitespace and typos
  • Standardize plot size and time
  • Verify operation (Signal Processing Toolbox check)
  • Build livescript and HTML

QC Example (qc_example)

  • Convert to .m
  • Fix whitespace and typos
  • Build livescript and HTML

River Example (river_example)

  • Convert to .m
  • Fix whitespace and typos
  • Build livescript and HTML

Short Term Extremes Example (short_term_extremes_example)

  • Convert to .m
  • Fix whitespace and typos
  • Define plot sizes
  • Build livescript and HTML

SWAN Example (SWAN_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Update visualization (pcolor)
  • Build livescript and HTML

Tidal Example (tidal_example)

  • Convert to .m
  • Improve whitespace and plotting
  • Build livescript and HTML

Upcrossing Example (upcrossing_example)

  • Convert to .m
  • Improve visualization size
  • Build livescript and HTML

Wave Example (wave_example)

  • Convert to .m
  • Fix whitespace and spelling
  • Update power matrix visualization
  • Build livescript and HTML

WECSim Example (wecsim_example)

  • Convert to .m
  • Update with latest MHKiT-Python changes
  • Update title
  • Build livescript and HTML

WPTO Hindcast Example (WPTO_hindcast_example)

  • Add visualizations
  • Improve robustness of downloads
  • Build livescript and HTML

@simmsa simmsa marked this pull request as ready for review February 15, 2025 00:52
@simmsa simmsa merged commit 707163e into MHKiT-Software:develop Feb 15, 2025
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant