Command Line Options

cdfviewer <files>... [options] [flags]

One or more NetCDF files, or a single zarr store, are required. All other arguments are optional. A typical invocation opens a file with a complete plot description.

cdfviewer demo.nc -v temperature -x lon -y lat -p heatmap --dims="time=5" -a time

Positional arguments

ArgumentDescription
filesPath(s) to the NetCDF file(s) to open (one or more), or a single zarr store directory (zarr format v2 only, v3 stores are detected but not yet supported). Combining multiple paths (multi-file aggregation) is NetCDF-only.

Options

OptionShortDescription
--var-vVariable to plot (-v u,v names both components of a vector plot)
--x-axis-xX-axis variable
--y-axis-yY-axis variable
--z-axis-zZ-axis variable (for 3D plots)
--plot_type-pType of plot to generate (e.g., contour, surface, scatter)
--overVariable to overlay on the same axis; repeatable, once per layer (--over='u,v' names both components of a vector layer)
--over-plotPlot type of the overlay, matched by position to --over; repeatable
--kwargsAdditional keyword arguments for the plot (as a Julia expression)
--dimsDimension indices as key=index pairs, e.g., --dims="time=5,lat=10"
--ani-dim-aDimension to use for animation
--saveoptions-sOptions for saving the figure (as a Julia expression)
--grid-gPath to a grid file providing coordinates that are not stored in the data file(s) (e.g. an ICON grid file)
--themeMakie theme to draw in: minimal (the default), light, dark, black, or ggplot2 (see Themes)

Flags

FlagDescription
--savefigOnly save the figure to file and exit
--recordOnly record the animation to a video file and exit
--menuShow the menu directly on start
--use-localUse a local directory for temporary operations to improve performance (see Configuration)
--no-grid-searchDisable the automatic search for a matching grid file
--no-summaryDo not print the dataset overview when a file is opened
--versionPrint cdfviewer <version> and exit
--helpPrint this option summary and exit

Notes

  • --kwargs and --saveoptions take the same key=value expressions as the corresponding REPL input. Quote them in the shell, e.g. --kwargs='colormap=:viridis, title="My Plot"'.
  • --over may be given several times, once per overlaid layer, and each one is drawn with the --over-plot in the same position. A keyword aimed at a single layer carries its prefix, e.g. --kwargs='over.levels=10, over2.arrows=(20, 14)' (see Overlaying Fields).
  • --savefig and --record run headlessly. No window is opened, the file is written, and the program exits (see Saving and Recording).
  • The export REPL command prints a ready-made argument string that reproduces the current session.