stglib Documentation
This package contains code to process data from a variety of oceanographic instrumentation, consistent with the procedures of the USGS Coastal/Marine Hazards and Resources Program (formerly Coastal and Marine Geology Program).
stglib serves two distinct but related purposes:
A library to import data into xarray Datasets, which can be manipulated in an interactive Python environment (e.g., IPython, Jupyter notebooks).
A series of run scripts to process data into CF-compliant netCDF files for release to the public.
Currently, this package has at least partial support for:
Nortek Aquadopp profilers, in mean-current wave-burst, and HR modes
Nortek Vector velocimeters
Nortek Signature profilers
Multiple RBR instruments, including moored and casting deployments
YSI EXO2 water-quality sondes
SonTek IQ flow monitors
WET labs sensors, including ECO NTUSB and ECO PAR
Onset HOBO pressure sensors
Vaisala Weather Transmitter WXT sensors
In-Situ Aqua TROLL sensors
RD Instruments ADCPs
Moving-boat ADCP data processed using QRev, for use in index-velocity computation
EofE ECHOLOGGER altimeters
SBE 37 Microcat
SBE 26plus Seagauge
TruBlue pressure sensors
AQUAscat1000R
We have plans to support:
RDI Sentinel V profilers
Contents:
- Installation
- Processing overview
- Configuration files
- Processing data with runots.py (use this!)
- Atmospheric compensation
- Processing waves
- stglib.core.waves.make_waves_ds
- stglib.core.waves.pressure_spectra
- stglib.core.waves.transfer_function
- stglib.core.waves.elevation_spectra
- stglib.core.waves.define_cutoff
- stglib.core.waves.make_tail
- stglib.core.waves.make_moment
- stglib.core.waves.make_Hs
- stglib.core.waves.make_Tm
- stglib.core.waves.make_Tp
- AQUAscat1000R
- Aquadopp (currents)
- Aquadopp HR
- Aquadopp (waves)
- RBR instruments
- Signature
- Vector
- WET Labs ECO
- EofE ECHOLOGGER
- YSI EXO
- Onset HOBO
- QRev data
- SonTek IQ
- Sequoia Scientific LISST
- Seabird SBE 37 MicroCAT
- SBE 26plus Seagauge (tides)
- SBE 26plus Seagauge (waves)
- TruBlue
- Lowell Tilt Current Meter (TCM)
- Vaisala WXT536
- Turnaround scripts
- API Documentation
- Contributing to stglib