MHKiT-Python
Installation
Refer to the MHKiT-Python installation section for information on how to install MHKiT-Python.
API Documentation
- QC Module
- Wave Module
- IO
- Resource
elevation_spectrum()
pierson_moskowitz_spectrum()
jonswap_spectrum()
surface_elevation()
frequency_moment()
significant_wave_height()
average_zero_crossing_period()
average_crest_period()
average_wave_period()
peak_period()
energy_period()
spectral_bandwidth()
spectral_width()
energy_flux()
energy_period_to_peak_period()
wave_celerity()
wave_length()
wave_number()
depth_regime()
- Performance
- Graphics
- Contours
- River Module
- Tidal Module
- Power Module
- Loads Module
- General
- Graphics
- Extreme
global_peaks()
number_of_short_term_peaks()
peaks_distribution_weibull()
peaks_distribution_weibull_tail_fit()
peaks_distribution_peaks_over_threshold()
ste_peaks()
block_maxima()
ste_block_maxima_gev()
ste_block_maxima_gumbel()
ste()
short_term_extreme()
full_seastate_long_term_extreme()
mler_coefficients()
mler_simulation()
mler_wave_amp_normalize()
mler_export_time_series()
return_year_value()
- DOLfYN Module
- ADP Module
- ADV Module
- IO
- Rotate
- Cleaning Data
- Motion Correction
- Velocity Analysis
TimeBinner
Velocity
Velocity.rotate2()
Velocity.set_declination()
Velocity.set_inst2head_rotmat()
Velocity.save()
Velocity.variables
Velocity.attrs
Velocity.coords
Velocity.u
Velocity.v
Velocity.w
Velocity.U
Velocity.U_mag
Velocity.U_dir
Velocity.E_coh
Velocity.I_tke
Velocity.I
Velocity.tke
Velocity.upvp_
Velocity.upwp_
Velocity.vpwp_
Velocity.upup_
Velocity.vpvp_
Velocity.wpwp_
VelBinner
- Turbulence Analysis
- Tools
- Time
- Utils Module
Examples
Jupyter notebook examples of MHKiT-Python are included below:
- MHKiT Quality Control Module
- MHKiT Wave Module
- MHKiT River Module
- MHKiT Tidal Module
- MHKiT Power Module
- MHKiT Loads Module
- MHKiT Environmental Contours
- MHKiT WEC-Sim Example
- MHKiT SWAN Example
- MHKiT WPTO Hindcast Example
- MHKiT CDIP IO
- PacWave Resource Assessment
- Delft3D IO Module
- Reading ADCP Data with MHKiT
- Reading ADV Data with MHKiT
- MLER example
- Extreme Conditions Modeling - Contour Approach
- Extreme Conditions Modeling - Full Sea State Approach
- MHKit Short-term Extreme Loads
Online Forum
Please post questions, feature requests, and bug reports about MHKiT-Python to the Issues Page. This forum is managed by the MHKiT-Python code development team and users.
Software Tests
MHKiT-Python includes continuous integration software tests that are run using Travis CI. The tests are run each time changes are made to the repository and are designed to ensure that the code is performing as expected. New tests are developed each time new functions are added or modified. Testing status (passing/failed) and code coverage statistics are posted on the README page.
Tests can also be run locally using the Python package nose. Developers should run software tests before submitting a pull request, using the following command:
nosetests -v --with-coverage --cover-package=mhkit mhkit