Command line interface#

emsarray provides a command line interface allowing users to use some of the more common operations directly from their shell.

When emsarray is installed, the command line interface will be available as emsarray. Run that command to get the full help pages:

$ emsarray --help

Available commands#

emsarray --version#

Print the installed version of emsarray.

emsarray clip#

Clip a dataset to a given GeoJSON geometry:

$ emsarray clip "./input-file.nc" "./clip.geojson" "./output-file.nc"

Or clip a dataset to some geographic bounds:

$ emsarray clip "./input-file.nc" "147.08,-43.67,147.30,-43.45" "./output-file.nc"

See emsarray clip --help for a full list of options.

emsarray export-geometry#

Exports the geometry of a dataset to various formats.

$ emsarray export-geometry gbr4.nc gbr.shp

The output format is guessed based on the extension of the output file, or specified manually using the --format flag.

Format

Flag

Extensions

GeoJSON

geojson

.geojson, .json

Shapefile

shapefile

.shp

Well Known Text

wkt

.wkt

Well Known Binary

wkb

.wkb

emsarray extract-points#

Extract the data at some points given in a CSV file:

$ emsarray extract-points gbr4.nc gbr4-points.csv gbr4-points.nc

See emsarray extract-points --help for a full list of options.

emsarray plot#

Render a simple plot of the dataset geometry, or of one variable. Call with just a dataset path to plot the dataset geometry.

# Plot the geometry of the dataset
$ emsarray plot gbr4.nc

Plot a single variable by passing its name as the second argument. You may have to select a single index from any extra dimensions, such as time and depth. Use the --sel or --isel flags for this, which will be passed to xarray.Dataset.sel() and xarray.Dataset.isel() respectively:

# Plot the surface temperature at the first timestep
$ emsarray plot gbr4.nc temp --isel k=-1 --isel record=0