Package API

Package API#

Note

Accessors are better documented in section Accessors API.

xoa

xarray-based ocean analysis library

xoa.cfgm

Configuration management utilities based on configobj

xoa.cli

Commandline interface for xoa

xoa.color

Colors and colormaps utilities

xoa.coords

Utilities for working with coordinates and dimensions.

xoa.core

Core low-level routines accelerated with numba

xoa.core.geo

Geographic utilities

xoa.core.interp

Low level interpolation routines accelerated with numba

xoa.core.num

Low level numeric utilities

xoa.core.regrid

Low level regridding routines accelerated with numba

xoa.core.sigma

Core terrain-folowing coordinate functions.

xoa.data_samples

Available data files that are used by xoa examples.

xoa.dyn

Routines related to ocean dynamics.

xoa.filter

Filtering utilities.

xoa.geo

Geographic utilities

xoa.grid

This module provides 1d to nD grid utilities to get information or perform operations on a grid.

xoa.krig

Kriging adapted from vacumm's module VACUMM/vacumm

xoa.meta

Meta-data and conventions management

xoa.misc

Miscellaneous low level utilities

xoa.plot

Plotting utilities

xoa.regrid

Regridding utilities.

xoa.thermdyn

Thermodynamics utilities.

xoa.sigma

Terrain following parametric vertical coordinates

Deprecated modules#

xoa.cf

Backward compatibility layer for the cf module