hpcflow.sdk.cli_common#
Click CLI options that are used as decorators in multiple modules.
Module attributes
Click option decorator: If specified, one of "json" or "yaml". |
|
|
Click option decorator: The directory in which the workflow will be generated. |
|
Click option decorator: The name of the workflow. |
Click option decorator: If True and the workflow directory (path + name) already exists, the existing directory will be overwritten. |
|
|
Click option decorator: The persistent store type to use. |
Click option decorator: The datetime format to use for storing datetimes. |
|
Click option decorator: The datetime format to use when generating the workflow name, where it includes a timestamp. |
|
Click option decorator: Workflow template variable value to be substituted in to the template file or string. |
|
Click option decorator: If True, allow multiple jobscripts to execute simultaneously. |
|
|
Click option decorator: If True, this command will block until the workflow execution is complete. |
Click option decorator: If True, add this submission to the known-submissions file. |
|
Click option decorator: If True, print the submitted jobscript indices for each submission index. |
|
|
Click option decorator: List of comma-separated task indices to include in this submission. |
|
Click option decorator: Immediately cancel the submission. |
Click option decorator: If True, display a live status to track submission progress. |
|
Click option decorator: If True, do not print anything about workflow submission. |
|
Click option decorator: If True, do not print anything (e.g. when jobscripts have completed). |
|
Click option decorator: If True, do not print anything (e.g. which jobscripts where cancelled). |
|
Click option decorator: Used to force the use of job arrays, even if the scheduler does not support it. |
|
Click option decorator: If True, display a live status to track workflow creation progress. |
|
|
|
|
Click option decorator: Path at which to create the new zipped workflow. |
Click option decorator: If set, any existing file will be overwritten. |
|
|
Click option decorator: Path to a log file to use during zipping. |
Click option decorator: Path at which to create the new unzipped workflow. |
|
Click option decorator: Path to a log file to use during unzipping. |
|
Click option decorator: First copy a backup of the array to a directory ending in .bak. |
|
Click option decorator: New chunk size (array items per chunk). |
|
Click option decorator: If True, display a live status to track rechunking progress. |
|
Click option decorator: If True, display a live status to track cancel progress. |
|
Click option decorator: Display up to this jobscript only. |
|
Click option decorator: Comma-separated list of jobscript indices to show. |
|
Click option decorator: Include jobscripts up to this jobscript only. |
|
Click option decorator: Comma-separated list of task name sub-strings to show. |
|
Click option decorator: Width in characters of the table to print. |
|
Click option decorator: For array jobs only, the job array index whose standard stream is to be printed. |
|
Click option decorator: If True, replace an existing environment with the same name and specifiers. |
|
Click option decorator: The environment source file to save the environment to, if specified. |
|
Click option decorator: The file name of the environment source file within the app config directory to save the environment to, if --env-source-file is not provided. |
|
Click option decorator: Paths to test files or directories to include in the Pytest run. |
Functions
Parse subtasks. |
Classes
Custom Click parameter type to accepts a bool or a choice of strings. |