dolfyn.read

dolfyn.read(fname, userdata=True, nens=None)[source]

Read a binary Nortek (e.g., .VEC, .wpr, .ad2cp, etc.) or RDI (.000, .PD0, etc.) data file.

Parameters
filenamestring

Filename of Nortek file to read.

userdataTrue, False, or string of userdata.json filename

(default True) Whether to read the ‘<base-filename>.userdata.json’ file.

nensNone (default: read entire file), int, or
2-element tuple (start, stop)

Number of pings to read from the file

Returns
dat<~dolfyn.data.velocity.Velocity>

A DOLfYN velocity data object.