Welcome to SeaSenseLib documentation!

SeaSenseLib is a library to process data from oceanographic sensor formats.

For recommendations or bug reports, please visit https://github.com/ocean-uhh/seasenselib/issues/new

Getting started

• About SeaSenseLib
• SeaSenseLib Overview
  • Where it fits in a data workflow
  • A minimal example
  • The processing pipeline
  • Command-line interface
• Installation
  • Requirements
  • Install from PyPI
  • Using conda or mamba
  • Development Installation
  • Alternative Installation Methods
  • Verify Installation
  • Troubleshooting

User guide

• User Guide
  • Quick Start
  • Reading Data
  • Creating Plots
  • Exporting Data
  • Data Processing
  • Command Line Interface
  • Working with Different Instruments
  • Getting Help

Demo notebooks

• SeaSenseLib Demo
  • Overview
  • Generalised API features
  • 1. Reading Data from Different Formats
  • 2. Data Exploration and Quality Assessment
  • 3. Data Conversion and Export
  • 4. Data Visualization
  • 5. Further data tools
  • Next Steps
• Formats Demo
  • SeaBird MicroCAT (CNV Format)
  • Nortek Aquadopp (DAT Format)
  • RBR TR1050 Thermistor (MAT Format)
  • RBR Solo T (RSK Format)
  • SeaSenseLib Format Keys

Help and reference

• GitHub Repo
• Supported File Formats
  • Format Keys Reference
  • Output Formats (Writers)
  • Plot Types (Plotters)
  • Usage Examples
  • Format Detection Summary
  • When to Use Format Keys
  • Checking Available Formats
• Reader Notes
  • SeaBird SBE HEX
  • RBR HEX
  • Nortek raw
  • RDI raw ADCP
• Developers Guide
  • Quick Start (Simplified API)
  • Modern API vs Legacy API
  • Readers Overview
  • Writers Overview
  • Plotters Overview
  • Data Processing
  • Command Line Usage
  • Format Key Reference
  • Troubleshooting and Migration
  • Working with Examples
• API Reference
  • Top-Level API Functions
  • Readers
  • Writers
  • Plotters
  • Processors
  • Pipeline System
  • Core Infrastructure
  • Canonical Parameters

Indices and tables

• Index

• Module Index

• Search Page