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
  • History
  • License
• Download and Install
  • Data Files and Test Files
  • Testing
  • Dependencies
• The Basics
  • Reading source data files
  • Data Groups
  • Subsetting data
  • Saving and loading data
  • Cleaning data
  • Averaging data
• Data Structure
  • Data Description and Units
    • Data Shortcuts (properties)
  • User Meta-Data (dat.props)
    • Specify meta-data in a JSON file
• Rotations and 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
  • Data processing
• Plotting Tools
• The DOLfYN API
  • DOLfYN data objects
    • dolfyn.Velocity
    • dolfyn.ADPdata
    • dolfyn.ADVdata
  • DOLfYN tools and functions
    • dolfyn.read
    • dolfyn.rotate2
    • dolfyn.adv.motion.CorrectMotion
    • dolfyn.VelBinner
    • dolfyn.adv.turbulence.TurbBinner
    • dolfyn.calc_principal_heading
• Glossary

Indices, tables and notes

• Index

• Search Page

• Glossary