Welcome to the DOLfYN home page

DOLfYN is the Doppler Oceanography Library for pYthoN.

It is designed to read and work with Acoustic Doppler Velocimeter (ADV) and Acoustic Doppler Profiler (ADP/ADCP) data. DOLfYN includes libraries for reading binary Nortek(tm) and Teledyne-RDI(tm) data files.

Please document any issues and submit feature requests via the DOLfYN issues page.

Table of Contents

• About
  • Instrument Support
  • History
  • License
• Installation
  • Data Files and Test Files
  • MATLAB Users
  • Testing
  • Dependencies
• The Basics
  • Reading Source Datafiles
  • Subsetting Data
  • Data Analysis Tools
  • The DOLfYN view
• Metadata
  • DOLfYN Attributes
• Rotations & Coordinate Systems
  • Orientation Data
  • Heading, Pitch, Roll
    • DOLfYN-Defined Heading, Pitch, Roll
    • Instrument heading, pitch, roll
  • Declination Handling
  • Principal Heading
  • Degree of testing by instrument type
• Motion Correction
  • Pre-Deployment Requirements
  • Specify metadata in a JSON file
  • Data Processing
  • Motion Correction Examples
    • ADV Motion Correction Ex.1
    • ADV Motion Correction Ex.2
• API Documentation
  • ADCP Module
    • Quick Example
    • 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()
  • ADV Module
    • Quick Example
    • Cleaning Data
      • clean_fill()
      • fill_nan_ensemble_mean()
      • spike_thresh()
      • range_limit()
      • GN2002()
      • CalcMotion
        • CalcMotion.reshape()
        • CalcMotion.calc_velacc()
        • CalcMotion.calc_velrot()
      • correct_motion()
  • Reading and Loading Data
    • read()
    • read_example()
    • save()
    • load()
    • save_mat()
    • load_mat()
  • Rotate Functions
    • rotate2()
    • calc_principal_heading()
    • set_declination()
    • set_inst2head_rotmat()
    • euler2orient()
    • orient2euler()
    • quaternion2orient()
    • calc_tilt()
  • Binning Tools
    • Velocity Analysis
    • Turbulence Analysis
      • TimeBinner
        • TimeBinner.reshape()
        • TimeBinner.detrend()
        • TimeBinner.demean()
        • TimeBinner.mean()
        • TimeBinner.var()
        • TimeBinner.std()
        • TimeBinner.calc_psd_base()
        • TimeBinner.calc_csd_base()
        • TimeBinner.calc_freq()
      • 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.do_avg()
        • VelBinner.do_var()
        • VelBinner.calc_coh()
        • VelBinner.calc_phase_angle()
        • VelBinner.calc_acov()
        • VelBinner.calc_xcov()
        • VelBinner.calc_tke()
        • VelBinner.calc_psd()
      • ADVBinner
        • ADVBinner.__call__()
        • ADVBinner.calc_stress()
        • ADVBinner.calc_csd()
        • ADVBinner.calc_doppler_noise()
        • ADVBinner.check_turbulence_cascade_slope()
        • ADVBinner.calc_epsilon_LT83()
        • ADVBinner.calc_epsilon_SF()
        • ADVBinner.calc_epsilon_TE01()
        • ADVBinner.calc_L_int()
      • calc_turbulence()
      • ADPBinner
        • ADPBinner.calc_dudz()
        • ADPBinner.calc_dvdz()
        • ADPBinner.calc_dwdz()
        • ADPBinner.calc_shear2()
        • ADPBinner.calc_doppler_noise()
        • ADPBinner.calc_stress_4beam()
        • ADPBinner.calc_stress_5beam()
        • ADPBinner.calc_total_tke()
        • ADPBinner.check_turbulence_cascade_slope()
        • ADPBinner.calc_dissipation_LT83()
        • ADPBinner.calc_dissipation_SF()
        • ADPBinner.calc_ustar_fit()
  • Data Shortcuts (Properties)
  • Time Conversion
    • epoch2dt64()
    • dt642epoch()
    • date2dt64()
    • dt642date()
    • epoch2date()
    • date2str()
    • date2epoch()
    • date2matlab()
    • matlab2date()
  • Tools
    • psd_freq()
    • stepsize()
    • coherence()
    • cpsd_quasisync()
    • cpsd()
    • psd()
    • phase_angle()
    • detrend()
    • group()
    • slice1d_along_axis()
    • fillgaps()
    • interpgaps()
    • medfiltnan()
    • convert_degrees()

Examples

• ADCP Example
• ADV Example

Indices

• Index

• Module Index