Savu Config Commands

The links on this page provide help for each command. If you are using the command line please type -h or --help.

savu_config --help

open

Open an existing process list.

usage: open [-h] [-s] file

Positional Arguments

file

The path to the process list to open.

Named Arguments

-s, --skip

Skip broken plugins.

Default: False

help

Display the help information

usage: help [-h]

disp

Display the plugins in the current list.

usage: disp [-h] [-q] [-v] [-vv] [-a] [-l] [-d] [start] [stop]

Positional Arguments

start

Display this list entry.

stop

Display entries from start to stop.

Named Arguments

-q, --quiet

Quiet mode. Display plugin names only.

Default: False

-v, --verbose

Verbose mode. Display plugin names, synopsis and parameter details.

Default: False

-vv, --vverbose

Verbose verbose mode. Display plugin names, full synopsis, parameter details and warnings.

Default: False

-a, --all

Display ALL parameters (user parameters only by default).

Default: False

-l, --level

Display current parameter visibility level.

Default: False

-d, --datasets

Display in_datasets and out_datasets.

Default: False

list

List the available plugins.

usage: list [-h] [-q] [-v] [-vv] [string]

Positional Arguments

string

List plugins or collections containing this string.

Default: “”

Named Arguments

-q, --quiet

Quiet mode. List plugin names only.

Default: False

-v, --verbose

Verbose mode. List plugin names and full synopsis.

Default: False

-vv, --vverbose

Verbose verbose mode. List all information.

Default: False

save

Save the current process list to file.

usage: save [-h] [-i] [-t] [filepath]

Positional Arguments

filepath

The output file path.

Named Arguments

-i, --input

Save to the input file.

Default: False

-t, --template

Create a Savu template file.

Default: False

mod

Modify plugin parameters.

usage: mod [-h] [-d] [-g] param [value [value ...]]

Positional Arguments

param

The plugin parameter to modify. Either ‘plugin_pos.param_name’ or ‘ plugin_pos.param_no’

value

The plugin parameter value.

Named Arguments

-d, --default

Revert to default value.

Default: False

-g, --globalpar

A global change of a parameter.

Default: False

set

Set the status of the plugin to be on or off.

usage: set [-h] plugin_pos [plugin_pos ...] {on,ON,off,OFF}

Positional Arguments

plugin_pos

Plugin position(s).

status

Possible choices: on, ON, off, OFF

Plugin status.

add

Add a plugin to the list.

usage: add [-h] name [pos]

Positional Arguments

name

The plugin name.

pos

Plugin list position (defaults to end).

dupl

Duplicate a plugin in the list

usage: dupl [-h] orig_pos [new_pos]

Positional Arguments

orig_pos

The position of the plugin to be duplicated.

new_pos

Position for the new plugin (defaults to end).

rem

Remove plugin(s) from the list.

usage: rem [-h] pos [pos ...]

Positional Arguments

pos

Plugin position(s).

move

Move a plugin to a different position in the list.

usage: move [-h] orig_pos new_pos

Positional Arguments

orig_pos

Original position.

new_pos

New position.

ref

Refresh a plugin (update it).

usage: ref [-h] [-d] pos [pos ...]

Positional Arguments

pos

Plugin position to refresh or ‘*’ for the whole list

Named Arguments

-d, --defaults, --default

Populate parameters with default values.

Default: False

level

Set a visibility level for the parameters.

usage: level [-h] [{basic,intermediate,advanced}]

Positional Arguments

level

Possible choices: basic, intermediate, advanced

The visibility level. Display the current visibility level by using ‘level’ without an argument.

expand

Expand the plugin preview parameter.

usage: expand [-h] [--off] [plugin_pos] [dim]

Positional Arguments

plugin_pos

Expand this plugin preview parameter

dim

Data dimensions. If this value is the same as the current dimension value, then the dimension of the preview parameter will be unchanged. If it is greater or smaller than the current dimension value, then the dimension of the preview value will be altered.

Named Arguments

--off

Turn off the expand view

Default: False

cite

Display plugin citations.

usage: cite [-h] [start] [stop]

Positional Arguments

start

Display this plugin citation.

stop

Display plugins from start to stop.

coll

List all plugin collections.

usage: coll [-h]

clear

Clear the current plugin list.

usage: clear [-h]

exit

Close the program.

usage: exit [-h]

history

View the history of previous commands

usage: history [-h]

iterate

Set a plugin (or group of plugins) to run iteratively.

usage: iterate [-h] [--set START END ITERATIONS]
               [--remove [LOOP_NUMBER [LOOP_NUMBER ...]]]

Named Arguments

--set

Set the start plugin index, end plugin index, and number of iterations

--remove

Remove a list of specific iterative loops, or all loops in the process list (pass no loop numbers to remove all)

replace

Replace a plugin with another

usage: replace [-h] old new_plugin

Positional Arguments

old

Old plugin position.

new_plugin

New plugin name.