tuchulcha-run

tuchulcha-run
Prev		Next

Name

tuchulcha-run — Command line workflow executor

Synopsis

tuchulcha-run [ help | --help | -h | -? ]

tuchulcha-run [--non-interactive] [--quiet] [setup-settings] [update] [update-dynamics parameterFile] [run parameterFile]

tuchulcha-run [-nqsudf] [parameterFile]

See the section called “Short Options” for more information about options/commands abbreviations.

Description

tuchulcha-run is able to update the plugin information used in tuchulcha and may execute given workflow files.

This command line application is used by tuchulcha in the background when updating its plugin information and running workflows. But in can be used as standalone command line application as well. It provides similar functionality as the charon workflow executor but needs less command line options since it has access to the settings of tuchulcha. If tuchulcha has never been run before, it is also capable to set up default path settings as tuchulcha would (using the setup-settings option).

tuchulcha-run does provide a Qt Gui event loop, so it is possible to use any Qt widget modules in the workflow e.g. for visualization. To avoid immediate termination after finishing the workflow execution, use the interactive session as described below.

Options

--non-interactive, -n: Do not enter interactive loop after execution of update/run commands. This is useful for script usage. If this option is not specified, an interactive session is started after handling the command line arguments. See the section called “Interactive Session” for more information.
--quiet, -q: Supress greeter and version information. Also hides command prompt to avoid showing up in tuchulcha logs.
help, --help, -h, -?, /?: display short help text and quit immediately
setup-settings, -s: if no or invalid path settings are detected, apply default path settings like tuchulcha would do
update, -u: update modules information used by tuchulcha
update-dynamics parameterFile, -d parameterFile: Update dynamic module information used by tuchulcha. This scans the given workflow for dynamic modules and generates their metadata information using the configuration from the workflow file which is passed to the module's prepareDynamicInterface function.
run parameterFile, -f parameterFile: execute the given workflow

Short Options

It is possible to combine the short options and commands e.g. like tuchulcha-run -nqf parameterFile, but please note that the -d or -f option have to be the last before the parameterFile argument and that -d and -f cannot be used together in one concatenation. (but e.g. tuchulcha-run -nqd file1 -f file2 works)

Interactive Session

The interactive session starts after handling the command line arguments if the --non-interactive option has not been specified. This session allows to interact with this application and e.g. wait before quit after running some workflows. This is useful if there are interactive modules in the workflow e.g. for visualization.

Any modules used in workflows stay loaded until you leave this application using the quit command. If started in the non-interactive mode, all modules are unloaded immediately after finishing the workflow execution. To stop any running workflow execution, you have to terminate this application e.g sending SIGTERM.

quit: Quit interactive session. No further commands are handled. If some update/run command is still running, the application terminates when it finished.
help: print short command summary
setup-settings: if no or invalid path settings are detected, apply default path settings like tuchulcha would do
update: update modules information used by tuchulcha
update-dynamics parameterFile: Update dynamic module information used by tuchulcha. This scans the given workflow for dynamic modules and generates their metadata information using the configuration from the workflow file which is passed to the module's prepareDynamicInterface function.
run parameterFile: execute the given workflow

Files

parameterFile

Parameter file describing the workflow to execute. This file may be set up e.g. by tuchulcha.

Paths specified in the parameter file (e.g. as filename of the fileReader module) may be given as relative paths to the parameter file location. tuchulcha-run changes its working directory to this location before starting the execution.