CLI Usage

cset bake

Used to run a recipe on some data. The recipe, input directory, and output directory must be provided. Additional help is available with the --help option. The recipe format is described on the Run an Operator Recipe page.

usage: cset bake [-h] [-i INPUT_DIR [INPUT_DIR ...]] -o OUTPUT_DIR -r RECIPE [-s STYLE_FILE] [--plot-resolution PLOT_RESOLUTION] [--skip-write]

options:
  -h, --help            show this help message and exit
  -i, --input-dir INPUT_DIR [INPUT_DIR ...]
                          Alternate way to set the INPUT_PATHS recipe variable
  -o, --output-dir OUTPUT_DIR
                          directory to write output into
  -r, --recipe RECIPE   recipe file to read
  -s, --style-file STYLE_FILE
                          colour bar definition to use
  --plot-resolution PLOT_RESOLUTION
                          plotting resolution in dpi
  --skip-write          Skip saving processed output

Here is an example to run a recipe making use of the templated variable VARNAME in the recipe. The ‘-v’ is optional to give verbose output:

cset -v bake -o 'OUTPUT_DIR' -r 'generic_surface_histogram_series.yaml' \
    --INPUT_PATHS='INPUT_DIR' \
    --VARNAME='air_pressure_at_sea_level' \
    --VALIDITY_TIME='2024-01-16T06:00Z'

When running cset bake multiple times for the same recipe it can cause issues with merging data into a single cube if output from a previous cset bake run exists in the chosen OUTPUT_DIR. In this case you need to delete the output data from the previous run.

cset cookbook

Saves an included recipe file to a local directory. This allows access to pre-created recipes for many common tasks. See Run an Operator Recipe, or use --details for descriptions of available recipes.

usage: cset cookbook [-h] [-d] [-o OUTPUT_DIR] [recipe]

positional arguments:
  recipe                recipe to output or detail

options:
  -h, --help            show this help message and exit
  -d, --details         list available recipes. Supplied recipes are detailed
  -o, --output-dir OUTPUT_DIR
                          directory to save recipes. If omitted uses $PWD

cset graph

Visualise a recipe. This renders a graph representing the recipe, and saves it to a temporary file, which is automatically opened. If the --details option is specified it also includes operator arguments in the output, so you can see exactly what ran.

usage: cset graph [-h] [-d] [-o [OUTPUT_PATH]] -r RECIPE

options:
  -h, --help            show this help message and exit
  -d, --details         include operator arguments in output
  -o, --output-path [OUTPUT_PATH]
                          persistent file to save the graph. Otherwise the file is opened
  -r, --recipe RECIPE   recipe file to read

cset extract-workflow

Unpack the CSET cylc workflow into a new directory under location. The current CSET conda environment is linked so it can be used by the workflow. For guided usage see Install the workflow.

usage: cset extract-workflow [-h] location

positional arguments:
  location    directory to save workflow into

options:
  -h, --help  show this help message and exit