Command Line Interface#

The following CLI options are available when running Climix:

Option

Args

Description

-h, --help

Show help, e.g., usage, version, positional arguments, and, CLI options.

-l, --log-level

debug, info, warning, error, critical

Set the lowest priority level of log messages to display, default is info.

-v, --verbose

Output more detailed log messages.

-d, --dask-scheduler

distributed-local-cluster, external, threaded, mpi, single-threaded

For more advanced usage of dask schedulers. Default is distributed-local-cluster.

-k, --keep-open

Keep Climix running until key press (useful for debugging).

-p, --period

seasonal, annual, monthly, annual[jan], annual[djf] etc.

Specify period for index (overrides index default period). Must be one of annual, seasonal, monthly. For annual period, an optional argument can be given to specify a range of months, e.g. annual[jja] for multiple months, or annual[feb] for a single month.

-s, --sliced-mode

Activate calculation per period to avoid memory problems.

-i, --iterative-storage

Store results iteratively per period.

-o, --output

/path/myfile.nc

Specify where the result is stored. If not used, by default Climix uses Output template generation to give the file a name and stores the result in the current working directory.

-f, --metadata-file

/path/mymetadatafile.yml

Add an external metadata file (overrides any default definitions), can be used multiple times to add several files (the last specified file will override any earlier definitions).

--activate-config

Specify if the Climix configuration should be activated. This will apply the default configuration for the output global attributes metadata. The default configuration file can be overridden by adding an external metadata file containing a configuration.

-r, --reference-period

1971/2000, P48Y/2000, 1971-06-01/2000, P47Y7M/2000

Specify reference period for an index (overrides the default reference period in the index definition), accepted formats are ISO 8601.

cp, --computational-period,

1961-01-01/1990-12-31, 2001-03-13/2009-05-20, etc.

Specify computational period for the index, i.e. limit the time interval to a subset of what is available in the input data. The start and end time strings must follow yyy-mm-dd/yyy-mm-dd format.

-x, --index

list, tn, fd, cdd, rx10day, r95pctl, tngtm2, txgt30, etc.

The index to calculate. -x list returns a list of all available indices.