Supported File Formats

SeaSenseLib supports reading data from various oceanographic instruments and file formats. This page provides a complete reference of all supported format keys.

Format Keys Reference

Format keys can be used with ssl.read(filename, file_format='key') when automatic detection fails or you need to override the default reader choice.

Supported Oceanographic Instruments
Manufacturer	Instrument	File Extensions	Format Key	Description
Anderaa	RCM	`.mat`	`rcm-matlab`	RCM MATLAB export format
Generic	CSV	`.csv`	`csv`	Comma-separated values format
Generic	NetCDF	`.nc`	`netcdf`	Network Common Data Form (CF-compliant)
Nortek	Aquadopp	`.dat` + `.hdr`	`nortek-ascii`	Nortek ASCII format (requires header file)
Nortek	Aquadopp	`.csv`	`nortek-csv`	Nortek AquaPro CSV export format
Nortek	Aquadopp, Aquadopp Gen2, Vector, AWAC	`.aqd`, `.VEC`, `.wpr`	`nortek-raw`	Nortek raw binary files; Gen2 `.aqd` and averaged `*_avgd.aqd` products are detected from the binary header (experimental)
RBR	Solo T	`.rsk`	`rbr-rsk`	RBR RSK native format (auto reader)
RBR	Solo T	`.rsk`	`rbr-rsk-default`	RBR RSK default reader
RBR	Solo T	`.rsk`	`rbr-rsk-legacy`	RBR RSK legacy format
RBR	TR1050	`.mat`	`rbr-matlab`	RBR MATLAB export format
RBR	TR1050	`.mat`	`rbr-matlab-legacy`	RBR MATLAB legacy format
RBR	TR1050	`.mat`	`rbr-matlab-rsktools`	RBR MATLAB RSKtools export
RBR	Various	`.txt`, `.dat`	`rbr-ascii`	RBR ASCII format
RBR	TR1050	`.hex`	`rbr-hex`	RBR binary HEX format (explicit format key required)
SeaBird	SBE37 MicroCAT	`.cnv`	`sbe-cnv`	SeaBird CNV format (time series)
SeaBird	SBE37 MicroCAT	`.hex`	`sbe-hex`	SeaBird HEX format (time series)
SeaBird	SBE 911	`.cnv`	`sbe-cnv`	SeaBird CNV format (CTD profiles)
SeaBird	SBE 911plus / 917plus	`.hex`	`sbe-hex`	SeaBird raw HEX (CTD profiles); the SBE 9 family is auto-detected from the `* Sea-Bird SBE 9 Data File` header
SeaBird	SBE16 Seacat	`.cnv`	`sbe-cnv`	SeaBird CNV format (CTD data)
SeaBird	SBE56	`.cnv`	`sbe-cnv`	SeaBird CNV format (thermistor data)
SeaBird	Various	`.txt`, `.dat`	`sbe-ascii`	SeaBird ASCII format
Sea & Sun	TOB	`.tob`	`seasun-tob`	Seasun TOB format
Teledyne RDI	ADCP	`.mat`	`adcp-matlab-uhhds`	ADCP MATLAB UHHDS format
Teledyne RDI	ADCP	`.mat`	`adcp-matlab-rdadcp`	ADCP MATLAB RDADCP format
Teledyne RDI	ADCP	`.000`, `.PD0`, `.ENR`, `.ENS`, `.ENX`	`rdi-raw`	RDI raw binary ADCP files

Output Formats (Writers)

SeaSenseLib can write an xarray Dataset back out to several formats with ssl.write(dataset, filename, file_format='key').

Supported Output Formats
Format	Format Key	File Extension
NetCDF	`netcdf`	`.nc`
CSV	`csv`	`.csv`
Excel	`excel`	`.xlsx`

Plot Types (Plotters)

SeaSenseLib provides several plot types via ssl.plot(plotter_key, dataset, ...).

Supported Plot Types
Plot Type	Plotter Key
Depth profile	`depth-profile`
Time series	`time-series`
T-S diagram	`ts-diagram`

Usage Examples

Automatic Detection (Recommended):

SeaSenseLib can automatically detect format for files with unique extensions:

import seasenselib as ssl

# Automatic detection for unique extensions
dataset = ssl.read('your_file.cnv')     # SeaBird CNV files
dataset = ssl.read('your_file.hex')     # SeaBird SBE37 HEX files
dataset = ssl.read('logger_data.rsk')   # RBR RSK files (auto-selects modern/legacy)
dataset = ssl.read('grid_data.nc')      # NetCDF files
dataset = ssl.read('sensor_data.csv')   # CSV files
dataset = ssl.read('tob_data.tob')      # Seasun TOB files
dataset = ssl.read('aquadopp.aqd')      # Nortek raw files

Explicit Format Specification:

# When automatic detection fails
dataset = ssl.read('data.txt', file_format='sbe-ascii')

# For ambiguous extensions like .mat
rbr_data = ssl.read('logger_export.mat', file_format='rbr-matlab')
adcp_data = ssl.read('current_data.mat', file_format='adcp-matlab-uhhds')

# RBR HEX files also require an explicit key because .hex auto-detects
# as SeaBird SBE37 HEX
rbr_hex_data = ssl.read('logger.hex', file_format='rbr-hex')

Multi-file Formats:

# Nortek instruments require both data and header files
nortek_data = ssl.read('current_meter.dat',
                       file_format='nortek-ascii',
                       header_file='current_meter.hdr')

# Nortek AquaPro CSV exports use an explicit format key because .csv is
# also used by the generic CSV reader
nortek_csv_data = ssl.read('Average Velocity DF3.csv',
                           file_format='nortek-csv')

# Nortek raw Aquadopp, Vector and AWAC data is decoded by MHKiT DOLfYN
# (experimental)
nortek_raw_data = ssl.read('DS-FDA01.aqd',
                           file_format='nortek-raw')

# RDI raw ADCP data is decoded by MHKiT DOLfYN
rdi_data = ssl.read('DS2_2025_recovery.000',
                    file_format='rdi-raw',
                    nens=100)

# Automatic detection also works for supported RDI raw suffixes:
rdi_data = ssl.read('DS2_2025_recovery.000', nens=100)

For reader-specific interpretation notes, including conservative RDI raw ADCP mapping choices, see Reader Notes.

Format Detection Summary

Auto-detected formats (unique file extensions):

.cnv → sbe-cnv (SeaBird CNV files)
.hex → sbe-hex (SeaBird SBE37 and SBE 911plus/917plus HEX files)
.rsk → rbr-rsk (RBR RSK files - automatically selects modern/legacy reader)
.nc → netcdf (NetCDF files)
.csv → csv (CSV files)
.tob → seasun-tob (Sea & Sun TOB files)
.aqd/.VEC/.wpr → nortek-raw (Nortek raw binary files via MHKiT DOLfYN, experimental)
.000/.PD0/.ENR/.ENS/.ENX → rdi-raw (RDI raw ADCP files via MHKiT DOLfYN)

Requires explicit format keys (ambiguous extensions):

RBR .hex files: rbr-hex (.hex otherwise auto-detects as sbe-hex)
.mat files: rbr-matlab, rcm-matlab, adcp-matlab-uhhds, adcp-matlab-rdadcp
.txt/.dat files: rbr-ascii, sbe-ascii, nortek-ascii
Nortek AquaPro .csv exports: nortek-csv (.csv otherwise auto-detects as generic csv)
Multi-file formats: nortek-ascii (requires both .dat and .hdr files)

When to Use Format Keys

Use explicit format specification when:

Files have ambiguous extensions (e.g., .txt, .dat, .mat)
You need to override the default reader choice
Working with multi-file formats like Nortek instruments
Auto-detection fails for any reason

Checking Available Formats

Use the command line to see all available readers:

seasenselib list readers

This will show you the current list of supported formats in your SeaSenseLib installation.