API Documentation

Aquadopp (currents)

stglib.aqd.hdr2cdf.hdr_to_cdf(metadata)

Load Aquadopp text files and output to netCDF format

stglib.aqd.cdf2nc.cdf_to_nc(cdf_filename[, ...])

Load a raw .cdf file and generate a processed .nc file

Aquadopp (waves)

stglib.aqd.wvswad2cdf.wad_to_cdf(metadata[, ...])

Load Aquadopp waves data and create raw netCDF file

stglib.aqd.wvscdf2nc.cdf_to_nc(cdf_filename)

Load a raw .cdf file and generate a processed .nc file

stglib.aqd.wvsnc2waves.nc_to_waves(nc_filename)

Process burst data to wave statistics

stglib.aqd.wvsnc2diwasp.nc_to_diwasp(nc_filename)

Process burst data to wave statistics by using DIWASP output from Matlab

Aquadopp HR

stglib.aqd.hdr2cdf.hdr_to_cdf(metadata)

Load Aquadopp text files and output to netCDF format

stglib.aqd.cdf2nc.cdf_to_nc(cdf_filename[, ...])

Load a raw .cdf file and generate a processed .nc file

RBR Instruments

stglib.rsk.rsk2cdf.rsk_to_cdf(metadata)

Main function to load data from RSK file and save to raw .CDF

stglib.rsk.cdf2nc.cdf_to_nc(cdf_filename[, ...])

Load raw .cdf file, trim, apply QAQC, and save to .nc

stglib.rsk.nc2waves.nc_to_waves(nc_filename)

Process burst data to wave statistics

EXO

stglib.exo.csv_to_cdf(metadata)

Process EXO .csv file to a raw .cdf file

stglib.exo.read_exo(filnam[, skiprows, encoding])

Read data from a YSI EXO multiparameter sonde .csv file into an xarray Dataset.

WET Labs

stglib.eco.read_par(filnam[, spb, skiprows, ...])

Read data from a WET Labs PAR csv file into an xarray Dataset.

stglib.eco.read_ntu(filnam[, spb, skiprows, ...])

Read data from a WET Labs NTU csv file into an xarray Dataset.

SonTek IQ

stglib.iq.read_iq(filnam)

Read SonTek IQ data which has been exported as a Matlab .mat file from IQ software into an xarray Dataset

Onset HOBO

stglib.hobo.read_hobo(filnam[, skiprows, ...])

Read data from an Onset HOBO pressure sensor .csv file into an xarray Dataset.

Signature

stglib.sig.mat2cdf.mat_to_cdf(metadata)

Load .mat files exported from Signature software and process to .cdf

stglib.sig.cdf2nc.cdf_to_nc(cdf_filename[, ...])

Load a raw .cdf file and generate a processed .nc file

Vaisala Weather Transmitter WXT

stglib.wxt.read_wxt(filnam[, skiprows, encoding])

Read data from a Vaisala WXT met .csv file into an xarray Dataset.

stglib.wxt.csv_to_cdf(metadata)

stglib.wxt.cdf_to_nc(cdf_filename)

Load a raw .cdf file and generate a processed .nc file

QRev

stglib.indexvel.parse_qrev_xml(doc[, ...])

Parse XML output from QRev and return as a Pandas DataFrame