Skip to content

Documents · Verb reference

show_cube_lexcube

Render a Lexcube widget as a side-effect and return the original cube.

Callable type: Grammar verb / pipe stage · Browse: Output and side effects

Usage

from cubedynamics import verbs as v
v.show_cube_lexcube(**kwargs)

Arguments

Argument Meaning Default
kwargs Forwarded directly to :func:cubedynamics.viz.show_cube_lexcube. forwarded arguments

Accepts

A 3-D DataArray with exactly (time, y, x) dimensions. Lexcube is an optional notebook widget, not the canonical website viewer.

Returns

A pass-through stage that displays a Lexcube widget and leaves the input cube in the pipe.

Order / grammar behavior

Install the optional dependency with python -m pip install "cubedynamics[viz]", restart the notebook kernel, and call this only while the cube still has time, y, and x dimensions.

Minimal example

A standalone, reviewed real-data example is not yet available for this helper. See the linked workflow and implementation notes; this reference does not substitute generated observations or invent an executable example.

Works with

A 3-D DataArray with exactly (time, y, x) dimensions. Lexcube is an optional notebook widget, not the canonical website viewer.

See also

Implementation notes

The incoming object must represent a 3D cube with dims (time, y, x). Lexcube is optional; install cubedynamics[viz] and restart the notebook kernel before using this verb. A missing extra raises a CubeDynamics dependency error with installation guidance. Reducers such as :func:mean, :func:variance, :func:anomaly, and :func:zscore keep the cube Lexcube-ready when keep_dim=True. Dask backing is preserved and only a light viewer object is created.

Implementation source. Signatures and descriptions on this page are generated from this checkout, not hand-maintained copies.