Package index

Connection / download

cm_setup()

Set up the Python environment used by Copernicus Marine

cm_connect()

Connect to the Copernicus Marine Python module

download_nc()

Download a subset from a Copernicus Marine dataset

Cube I/O

ocean_cube()

Construct an oceanographic data cube

read_nc()

Read NetCDF variables as an ocean cube

cube_open()

Open a local NetCDF file as a deferred ocean cube

cube_collect()

Materialize an ocean cube in memory

Validation / inspection

cube_validate()

Validate an ocean cube

cube_inspect()

Inspect an ocean cube

print(<oceancube_validation>)

Print an ocean cube validation report

print(<ocean_cube_inspection>)

Print an ocean cube inspection

Selection and extraction

cube_slice()

Select discrete positions or coordinate values from an ocean cube

cube_crop()

Crop an ocean cube with closed coordinate ranges

cube_extract()

Extract ocean-cube cells as a data frame

cube_transect()

Extract an ordered ocean transect as a table

Masks and spatial context

cube_mask()

Mask an ocean cube with polygon cell-centre coverage

stock_mask()

Create a stock-oriented spatial mask

crop_stock()

Apply a stock mask to an ocean cube

coast_dist()

Attach distance to coast to an ocean cube

Geometry and weights

cube_cell_area()

Compute horizontal cell areas for an ocean cube

cube_layer_thickness()

Compute vertical layer thicknesses for an ocean cube

cube_cell_volume()

Compute three-dimensional cell volumes for an ocean cube

cube_polygon_weights()

Build polygon-to-cube geometric weights

Visualization

viz.map()

Draw a static map from one ocean-cube layer

viz.section()

Draw a static vertical section from an ocean cube

viz.profile()

Draw a vertical profile from an ocean cube

viz.transect()

Draw a static transect from an ocean cube

viz.timeseries()

Draw a raw point time series from an ocean cube

viz.hovmoller()

Draw a Hovmoller diagram from one ocean-cube plane

Temporal aggregation

cube_aggregate_time()

Aggregate an ocean cube along the time dimension

Climatology and anomalies

cube_climatology()

Compute a recurrent climatology from an ocean cube

cube_anomaly()

Compute pointwise anomalies from a canonical climatology

Trend

cube_trend()

Compute descriptive per-cell linear temporal trends

Compatibility helpers

to_month()

Aggregate an ocean cube to monthly resolution

clim_month()

Compute monthly climatology from an ocean cube

clim_day()

Compute daily climatology from an ocean cube

anom_diff()

Compute signed difference anomalies from a legacy climatology

anom_z()

Compute standardized anomalies from a legacy climatology

signal_noise()

Standardized climatological anomaly magnitude

Summaries and linkage

annual_index()

Compute annual indicators from an ocean cube

oxygen_boundary()

Resolve explicit oxygen-threshold zone boundaries

transition_layer()

Diagnose a variable-aware vertical transition-layer candidate

depth_feature()

Detect the strongest certified vertical-gradient candidate

depth_gradient()

Compute certified vertical secant gradients

depth_sample()

Sample a cube at physical metric depths

layer_mean()

Average an ocean cube over vertical layers

layer_integral()

Integrate CF vertical cell means over metric depth

mixed_layer_depth()

Estimate temperature- or density-threshold mixed-layer depth

thermodynamic_state()

Construct a certified TEOS-10 thermodynamic state

stratification()

Compute certified TEOS-10 buoyancy-frequency-squared stratification

link_events()

Link gridded ocean-cube values to event points