Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Learn about seaduck core objects and functions

Another good way to learn about the package is to learn how different objects are used and related to each other.

Object Name (and link to API reference)Main functionalityExample
seaduck.OceDataInterface to data, translate between lat-lon and indices.AVISO
seaduck.TopologyDescribe the how the grids are connected. Similar to xgcm.topology tutorial
seaduck.KnWDefine what interpolation/derivative to perform.ECCO
seaduck.PositionInterpolate at Eulerian positions.Interpolate in a fjord
seaduck.ParticlePerform Lagrangian particle simulation. Sub class of seaduck.PositionRegional simulation
seaduck.OceInterpUniform interface to Lagrangian and Eulerian operations.one minute guide, ECCO