utopya eval

Contents

utopya eval#

utopya eval#

Evaluate a previously finished simulation run.

Loads a simulation of the given MODEL_NAME` model and evaluates it either using the configured defaults or with custom plots configs. If no ``RUN_DIR is given, will use the latest run; to evaluate a specific simulation, specifying the directory name or timestamp suffices.

If enabled, shell-completion will suggest directory names from a set of (configurable) candidate output directories.

utopya eval [OPTIONS] MODEL_NAME [RUN_DIR]

Options

--run-cfg <run_cfg>#

An optional run config that can be used if changes to the meta config are desired. This affects evaluation indirectly as it determines some of the behavior for data loading and setup of the plotting infrastructure.

--cfg-set, --cs <cfg_set>#

If the chosen model provides configuration sets, use the config files from the chosen set for the run and plots config. Note that the specific arguments still take precedence over the values from the config sets; to use default paths, specify empty strings ('') for those arguments.

--label <label>#

For model names that have multiple info bundles registered, a label is needed to unambiguously select the desired one. Alternatively, use the utopya models set-default CLI command to set a default label for a model.

-p, --set-params <set_params>#

Sets entries in the meta configuration using key-value pairs. Example: -p some.param=42 sets the param entry in some to 42. Specify DELETE as value to remove an entry. Repeat the -p option to set multiple values.

-P, --load-parallel#

If given, will force loading data in parallel.

--use-data-tree-cache, --tc#

If set, uses tree file caching: If no cache file exists, creates one after loading all data; if a tree file already exists, uses that to restore the data tree. This may bring a speed-up if the creation of the data tree takes a long time.

--show-data-tree <show_data_tree>#

Controls which kind of data tree should be shown after loading.

Default:

condensed

Options:

full | condensed | none

--plots-cfg <plots_cfg>#

If given, uses the plots configuration file found at this path instead of the defaults for the model.

-u, --update-plots-cfg <update_plots_cfg>#

Sets entries in the selected plots config. Example: -u my_plot.some_param=42 sets the some_param entry in the plot configuration named my_plot. Repeat the -u option to set multiple values.

--plot-only, --po <plot_only>#

If given, will plot only those entries of the plot configuration that match the names given here. This can also be used to activate plots that are disabled in the specified plot configuration. Note that simple name globbing is supported, but the argument needs to be put into quotes to not conflict with the globbing done by the shell. Repeat the --po option to denote multiple plot_only arguments.

-i, --interactive#

If set, the CLI will not exit after plotting finished, but allow to continue plotting in an interactive session. This option is useful for creating multiple plots in an iterative fashion, especially if data loading time is large. Note that all Multiverse-related configuration options can not be changed during the session and have to be set beforehand.

-R, --reveal-output#

If set, opens the output directory after plotting finished.

-d, --debug#

The debug level.

--cluster-mode#

Enables cluster mode.

Arguments

MODEL_NAME#

Required argument

RUN_DIR#

Optional argument