API Documentation

MHKiT-Python API

• QC Module
  • check_timestamp()
  • check_missing()
  • check_corrupt()
  • check_range()
  • check_delta()
  • check_outlier()
• Wave Module
  • IO
    • Wave IO (Input/Output) Function Summary
      • CDiP
      • NDBC
      • SWAN
      • WEC-Sim
      • WPTO Hindcast
      • WIND Toolkit Hindcast
        • CDiP Data
          • request_netCDF()
          • request_parse_workflow()
          • get_netcdf_variables()
        • NDBC Data
          • read_file()
          • available_data()
          • request_data()
          • to_datetime_index()
          • dates_to_datetime()
          • parameter_units()
          • request_directional_data()
          • create_spread_function()
          • create_directional_spectrum()
          • get_buoy_metadata()
        • SWAN Data
          • read_table()
          • read_block()
          • dictionary_of_block_to_table()
          • block_to_table()
        • WEC-Sim Data
          • read_output()
        • WPTO Hindcast Data
          • region_selection()
          • request_wpto_point_data()
          • request_wpto_directional_spectrum()
        • WIND Toolkit Data
          • Wind Toolkit Data Utility Functions
            • Key Functions:
            • Dependencies:
            • Notes:
            • Author:
            • Date:
          • region_selection()
          • get_region_data()
          • plot_region()
          • elevation_to_string()
          • request_wtk_point_data()
      • 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
        • capture_length()
        • statistics()
        • capture_length_matrix()
        • wave_energy_flux_matrix()
        • power_matrix()
        • mean_annual_energy_production_timeseries()
        • mean_annual_energy_production_matrix()
        • power_performance_workflow()
      • Graphics
        • plot_spectrum()
        • plot_elevation_timeseries()
        • plot_matrix()
        • plot_chakrabarti()
        • plot_environmental_contour()
        • plot_avg_annual_energy_matrix()
        • monthly_cumulative_distribution()
        • plot_compendium()
        • plot_boxplot()
        • plot_directional_spectrum()
      • Contours
        • environmental_contours()
        • PCA_contour()
        • samples_full_seastate()
        • samples_contour()
• River Module
  • IO
    • get_all_time()
    • index_to_seconds()
    • seconds_to_index()
    • get_layer_data()
    • create_points()
    • variable_interpolation()
    • get_all_data_points()
    • turbulent_intensity()
    • read_usgs_file()
    • request_usgs_data()
  • Resource
    • Froude_number()
    • exceedance_probability()
    • polynomial_fit()
    • discharge_to_velocity()
    • velocity_to_power()
    • energy_produced()
  • Performance
    • circular()
    • ducted()
    • rectangular()
    • multiple_circular()
    • tip_speed_ratio()
    • power_coefficient()
  • Graphics
    • plot_flow_duration_curve()
    • plot_velocity_duration_curve()
    • plot_power_duration_curve()
    • plot_discharge_timeseries()
    • plot_discharge_vs_velocity()
    • plot_velocity_vs_power()
• Tidal Module
  • IO
  • Resource
    • principal_flow_directions()
    • Froude_number()
    • exceedance_probability()
  • Performance
    • power_curve()
    • velocity_profiles()
    • device_efficiency()
    • circular()
    • ducted()
    • rectangular()
    • multiple_circular()
    • tip_speed_ratio()
    • power_coefficient()
  • Graphics
    • plot_rose()
    • plot_joint_probability_distribution()
    • plot_current_timeseries()
    • tidal_phase_probability()
    • tidal_phase_exceedance()
• Power Module
  • Characteristics
    • instantaneous_frequency()
    • dc_power()
    • ac_power_three_phase()
  • Quality
    • harmonics()
    • harmonic_subgroups()
    • total_harmonic_current_distortion()
    • interharmonics()
• Loads Module
  • General
    • bin_statistics()
    • blade_moments()
    • damage_equivalent_load()
  • Graphics
    • plot_statistics()
    • plot_bin_statistics()
  • Extreme
• DOLfYN Module
  • ADP Module
  • ADV Module
  • IO
    • read()
    • read_example()
    • save()
    • load()
    • save_mat()
    • load_mat()
    • read_nortek()
    • read_signature()
    • split_dp_datasets()
    • read_rdi()
  • Rotate
    • rotate2()
    • calc_principal_heading()
    • set_declination()
    • set_inst2head_rotmat()
    • euler2orient()
    • orient2euler()
    • quaternion2orient()
    • calc_tilt()
  • Cleaning Data
    • set_range_offset()
    • find_surface()
    • find_surface_from_P()
    • nan_beyond_surface()
    • correlation_filter()
    • medfilt_orient()
    • val_exceeds_thresh()
    • fillgaps_time()
    • fillgaps_depth()
    • clean_fill()
    • fill_nan_ensemble_mean()
    • spike_thresh()
    • range_limit()
    • GN2002()
  • Motion Correction
  • Velocity Analysis
    • TimeBinner
      • TimeBinner.reshape()
      • TimeBinner.detrend()
      • TimeBinner.demean()
      • TimeBinner.mean()
      • TimeBinner.variance()
      • TimeBinner.standard_deviation()
    • 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
      • VelBinner.tke
      • VelBinner.tau
      • VelBinner.S
      • VelBinner.C
      • VelBinner.bin_average()
      • VelBinner.bin_variance()
      • VelBinner.autocovariance()
      • VelBinner.turbulence_intensity()
      • VelBinner.turbulent_kinetic_energy()
      • VelBinner.power_spectral_density()
  • Turbulence Analysis
    • ADVBinner
      • ADVBinner.reynolds_stress()
      • ADVBinner.cross_spectral_density()
      • ADVBinner.doppler_noise_level()
      • ADVBinner.check_turbulence_cascade_slope()
      • ADVBinner.dissipation_rate_LT83()
      • ADVBinner.dissipation_rate_SF()
      • ADVBinner.dissipation_rate_TE01()
      • ADVBinner.integral_length_scales()
    • turbulence_statistics()
  • Tools
    • fft_frequency()
    • cpsd_quasisync_1D()
    • cpsd_1D()
    • psd_1D()
    • detrend_array()
    • group()
    • slice1d_along_axis()
    • convert_degrees()
    • fillgaps()
    • interpgaps()
    • medfiltnan()
  • Time
    • epoch2dt64()
    • dt642epoch()
    • date2dt64()
    • dt642date()
    • epoch2date()
    • date2str()
    • date2epoch()
    • date2matlab()
    • matlab2date()
• Mooring Module
  • IO
    • read_moordyn()
  • Graphics
    • animate()
• Utils Module

MHKiT-MATLAB API

• QC Module
• Wave Module
  • IO
  • Resource
  • Performance
  • Graphics
• River Module
  • IO
  • Resource
  • Performance
  • Graphics
• Tidal Module
  • IO
  • Resource
  • Performance
  • Graphics
• Power Module
  • Characteristics
  • Quality
• Loads Module
  • General
  • Graphics
• Utils Module