Examples

Overview

This page details all the available examples of MHKiT functions and features. Python examples are available as Jupyter notebooks and MATLAB examples as live scripts. Not all MATLAB examples are available yet but are coming soon.

There are many examples that cover a range of applications and areas of interest. Search for the following tags to identify relevant examples:

Tag	Description
wave	Examples analyzing a WEC, reading WEC model data, assessing wave resource, etc
current	Examples analyzing a CEC, reading WEC model data, assessing current resource, etc
loads	Examples assessing extreme loading conditions, extreme responses, WDRT, etc
mooring	Examples reading MoorDyn data, visualizing mooring lines motion, etc
power	Examples analyzing electrical power production, etc
resource	Examples involving marine energy resource characterization
iec	Examples utilizing IEC marine energy standards
qc	Examples preparing data, doing quality control, etc

Title	MHKiT-Python	MHKiT-MATLAB	Description	Tags
Quality Control	Notebook	Live Script	Data quality control workflow example	qc
River Example	Notebook	Live Script	Visualize river current energy from USGS data	current, resource, iec
Tidal Example	Notebook	Live Script	Visualize velocity duration curve from NOAA tidal data	current, resource, iec
Tidal Power Performance Example	Notebook	Live Script	Tidal power performance testing workflow	current, iec
ADCP Example	Notebook	Live Script	Acoustic Doppler Current Profiler (ADCP) analysis workflow	current, resource
ADCP Discharge Example	Notebook	Coming soon	Acoustic Doppler Current Profiler (ADCP) discharge workflow	current, resource
ADV Example	Notebook	Live Script	Acoustic Doppler Velocimetry (ADV) analysis workflow	current, resource
Tanana River Resource Characterization	Notebook	Coming soon	Site-specific river resource characterization	current, resource
Delft3D	Notebook	Live Script	Analyze and visualize output from Delft3D	current, resource
WEC Power Performance	Notebook	Live Script	Visualize WEC Power vs. Wave Resource	wave, resource, iec
Directional Waves Analysis	Notebook	Coming soon	Visualize directional wave energy spectra from NDBC data	wave, resource
Environmental Contours	Notebook	Live Script	Visualize estimates of extreme sea states	wave, resource
PacWave Resource Characterization	Notebook	Coming soon	Site-specific resource characterization using NDBC data	wave, resource, iec
CDIP	Notebook	Live Script	Download and visualize CDIP resource data	wave, resource
WEC-Sim	Notebook	Live Script	Visualize output from WEC-Sim	wave
WEC-Sim Power Performance	Notebook	Live Script	Visualize output from WEC-Sim	wave, resource
SWAN	Notebook	Live Script	Visualize output from Simulating Waves Nearshore (SWAN)	wave
WPTO Hindcast	Notebook	Live Script	Download and visualize WPTO Hindcast data	wave, resource
Metocean Analysis	Notebook	Coming soon	Download and visualize NDBC metocean data	wave, resource
Upcrossing Analysis	Notebook	Live Script	Analyze the surface elevation of a wave	wave
Loads Analysis	Notebook	Live Script	Compute structural loads quantities of interest	loads
Extreme Response MLER	Notebook	Live Script	Extreme conditions model - Most Likely Extreme Response (MLER)	loads, wave
Extreme Response Contour	Notebook	Live Script	Extreme conditions model - contour approach	loads, wave
Extreme Response Full Sea State	Notebook	Live Script	Extreme conditions model - full sea state approach	loads, wave
Short-Term Extremes	Notebook	Live Script	Visualize probability distribution of short-term time series data	loads, wave
Mooring	Notebook	Live Script	Visualize and analyze output from MoorDyn	mooring, wave
Electrical Power Analysis	Notebook	Live Script	Compute 3-phase power quantities of interest	power, iec
Acoustics	Notebook	Live Script	Ingest, analyze and visualize passive acoustic output	acoustics, iec
Strain Gauge Processing	Notebook	Live Script	Ingest, analyze and visualize strain gauge measurements	strain