Published February 17, 2026 | Version v2.0.0
Software Open

zarr-dump v2

Authors/Creators

  • 1. UNSW

Description

2 new features in this release:

  • CF conventions tooling
    • CF summary in the default dump output:
      • Detects axes (T/Z/Y/X) and works with both rectilinear and curvilinear grids (e.g. 2D lat(y,x) / lon(y,x) referenced via coordinates)
      • Suggests plot dims and slice dims
      • Lists candidate data variables (excluding coordinate-like variables)
    • cf-check subcommand with metadata + light-touch coordinate checks (exits non-zero if any errors are found)
  • 2D slice plotting in an interactive window (viridis colormap)
    • zarr-dump STORE --plot VAR --plot-dims dim_y,dim_x --slice dim=index ...
    • Optional in-window navigation for non-plotted dimensions

CF conventions:

# Run CF-focused checks (exits non-zero if any ERRORs are present)
zarr-dump cf-check /path/to/zarr/store

Checks include (high level):

  • Conventions/conventions presence and CF-like content
  • Dimension name list validation (_ARRAY_DIMENSIONS / dimension_names)
  • Coordinate-variable checks (units type, bounds references, sampled monotonicity where readable)
  • Time/vertical/lat/lon semantics checks (e.g. CF-style time units, calendar values, positive, lat/lon ranges)
  • Reference attribute checks (coordinates, ancillary_variables, cell_measures, cell_methods, grid_mapping, formula_terms)
  • Auxiliary 2D lat/lon detection and validation (including whether they're referenced via coordinates)

2D slice plotting:

# Plot a 2D slice of a variable (requires exactly 2 plotted dims)
# Provide --slice for every remaining dimension not included in --plot-dims.
zarr-dump /path/to/zarr/store \
  --plot temperature \
  --plot-dims y,x \
  --slice time=0

If the variable has extra dimensions (beyond the two plotted dims), the viewer supports interactive navigation:

  • Tab: next dimension
  • ←/→ or ↑/↓: ±1 (Shift = ×10)
  • PgUp/PgDn: ±10 (Shift = ×100)
  • Home/End: min/max
  • Esc/q: quit

Notes:

  • Plotting is only supported in the default mode (zarr-dump STORE --plot ...).
  • -c/--coordinate-data is not supported together with --plot.

Files

greensh16/zarr-dump-v2.0.0.zip

Files (58.6 kB)

Name Size Download all
md5:af69a22c62543214cc9bdb599351f2fa
58.6 kB Preview Download

Additional details

Related works