Difference between revisions of "Rewrite Startup Usage"
Jump to navigation
Jump to search
(Created page with '<pre> usage: vistrails [-e] [-b] [-o DIR] [-p [PACKAGE [PACKAGE ...]]] [--with-version-tree] [--with-workflow] [CONFIGURATION OPTIONS] [vistrail…') |
(→Notes) |
||
Line 167: | Line 167: | ||
to VisTrails (e.g. www.crowdlabs.org) | to VisTrails (e.g. www.crowdlabs.org) | ||
</pre> | </pre> | ||
== Notes == | |||
* Run in console mode from run.py ? (single entry-point) | |||
* Running different versions of the same vistrails shows the "autosave data has been found" window. | |||
* An option to shutdown after running specified workflows (with -w)? | |||
* A shortcut to specify multiple versions of a single workflow was discussed in the meeting. | |||
** [RR] Is it really needed? A bourne-compatible shell already expands ''vt-name.vt:{version1,version2}'' |
Latest revision as of 18:41, 16 October 2013
usage: vistrails [-e] [-b] [-o DIR] [-p [PACKAGE [PACKAGE ...]]] [--with-version-tree] [--with-workflow] [CONFIGURATION OPTIONS] [vistrail [vistrail ...]] positional arguments: vistrail Vistrail to open optional arguments: -h, --help show this help message and exit -e, --execute Execute any specified workflows -b, --batch Run vistrails in batch mode instead of interactive mode -o DIR, --output-directory DIR -p [PACKAGE [PACKAGE ...]], --package [PACKAGE [PACKAGE ...]] --with-version-tree Output the version tree as an image --with-workflow Output the workflow graph as an image Path Arguments: --subworkflows-directory DIR The location where a user's local subworkflows are stored. --data-directory DIR The location that VisTrails uses as a default directory for data. -S DIR, --dot-vistrails DIR The location to look for VisTrails user configurations and storage. Defaults to ~/.vistrails. --file-directory DIR The location that VisTrails uses as a default directory for specifying files. --log-directory DIR The path that indicates where log files should be stored. --package-directory DIR The directory to look for VisTrails core packages (use userPackageDirectory for user-defined packages) --repository-local-path DIR Path used to locate packages available to be installed --root-directory DIR Directory that contains the VisTrails source code. --temporary-directory DIR The directory to use for temporary files generated by VisTrails --user-package-directory DIR The location for user-installed packages (defaults to ~/.vistrails/userpacakges) Configuration Options: --auto-connect Try to automatically connect a newly dragged in module to the rest of the workflow. --no-auto-connect Inverse of --auto-connect --auto-save Automatically save vistrails to allow recovery from crashes, etc. --no-auto-save Inverse of --auto-save --db-default Use a database as the default storage location for vistrails entities. --no-db-default Inverse of --db-default --default-file-type DEFAULTFILETYPE Defaults to .vt but could be .xml. --detach-history-view Show the version tree in a separate window --no-detach-history-view Inverse of --detach-history-view --enable-packages-silently Do not prompt the user to enable packages, just do so automatically --no-enable-packages-silently Inverse of --enable-packages-silently --install-bundles Whether to try to install missing Python dependencies --no-install-bundles Inverse of --install-bundles --install-bundles-with-pip Whether to try to use pip to install Python dependencies or use distribution support. --no-install-bundles-with-pip Inverse of --install-bundles-with-pip --maximize-windows Whether the VisTrails windows should take up the entire screen space --no-maximize-windows Inverse of --maximize-windows --max-recent-vistrails MAXRECENTVISTRAILS How many recently opened vistrails should be stored for "Open Recent" access. --migrate-tags Whether or not the tag on a workflow that was upgraded should be moved to point to the upgraded version. --no-migrate-tags Inverse of --migrate-tags --multi-heads Whether or not to use multiple screens for VisTrails windows. --no-multi-heads Inverse of --multi-heads --execution-log Track execution provenance when running workflows --no-execution-log Inverse of --execution-log --repository-httpurl URL URL used to locate packages available to be installed --shell-font-face FONTFACE The font to be used for the VisTrails console --shell-font-size FONTSIZE The font size used for the VisTrails console --show-connection-errors Alert the user if the value along a connection doesn't match connection types. --hide-connection-errors Inverse of --show-connection-errors --show-variant-errors Alert the user if the value along a connection coming from a Variant output matches the input port. --hide-variant-errors Inverse of --show-variant-errors --show-debug-popups Always show the debug popups or only if there is a modal widget. --hide-debug-popups Inverse of --show-debug-popups --show-scrollbars Whether VisTrails should show scrollbars on the version tree and workflow canvases. --hide-scrollbars Inverse of --show-scrollbars --show-splash Whether the VisTrails splash screen should be shown on startup. --hide-splash Inverse of --show-splash --show-window --hide-window Inverse of --show-window --single-instance Whether or not VisTrails should only allow one instance to be running --no-single-instance Inverse of --single-instance --static-registry DIR If specified, VisTrails uses an XML file defining the VisTrails module registry to load modules instead of from the packages directly --stop-on-error Whether or not VisTrails stops executing the rest of the workflow if it encounters an error in one module. --no-stop-on-error Inverse of --stop-on-error --thumbs-auto-save Whether to save thumbnails of results when executing VisTrails --no-thumbs-auto-save Inverse of --thumbs-auto-save --thumbs-cache-directory DIR The directory to be used to cache thumbnails --thumbs-cache-size CACHESIZE The size (in MB) of the thumbnail cache --thumbs-mouse-hover Whether to show thumbnails when hovering over a version in the version tree --no-thumbs-mouse-hover Inverse of --thumbs-mouse-hover --thumbs-tags-only If True, only stores thumbnails for tagged versions. Otherwise, stores thumbnails for all versions. --no-thumbs-tags-only Inverse of --thumbs-tags-only --upgrades --no-upgrades Inverse of --upgrades --upgrade-delay If True, will only persist the upgrade when a user makes a modification to or executes the workflow. Otherwise, the upgrade will be automatically added to the version tree when a user views an upgraded workflow. --no-upgrade-delay Inverse of --upgrade-delay --upgrade-module-fail-prompt Whether to alert the user when an upgrade may fail when upgrading a subworkflow. --no-upgrade-module-fail-prompt Inverse of --upgrade-module-fail-prompt --cache Cache previous results so they may be used in future computations --no-cache Inverse of --cache --debug-level DEBUGLEVEL How much information VisTrails should alert the user about (0: Critical errors only, 1: Critical errors and warnings, 2: Critical errors, warnings, and log messages). --web-repository-user WEBREPOSITORYUSER The default username for logging into a VisTrails web repository like crowdLabs --web-repository-url URL The URL of the web repository that should be attached to VisTrails (e.g. www.crowdlabs.org)
Notes
- Run in console mode from run.py ? (single entry-point)
- Running different versions of the same vistrails shows the "autosave data has been found" window.
- An option to shutdown after running specified workflows (with -w)?
- A shortcut to specify multiple versions of a single workflow was discussed in the meeting.
- [RR] Is it really needed? A bourne-compatible shell already expands vt-name.vt:{version1,version2}