hpcflow.sdk.cli_common

Click CLI options that are used as decorators in multiple modules.

Module attributes

format_option(f)	Click option decorator: If specified, one of "json" or "yaml".
path_option(f)	Click option decorator: The directory path into which the new workflow will be generated.
name_option(f)	Click option decorator: The name of the workflow.
overwrite_option(f)	Click option decorator: If True and the workflow directory (path + name) already exists, the existing directory will be overwritten.
store_option(f)	Click option decorator: The persistent store type to use.
ts_fmt_option(f)	Click option decorator: The datetime format to use for storing datetimes.
ts_name_fmt_option(f)	Click option decorator: The datetime format to use when generating the workflow name, where it includes a timestamp.
variables_option(f)	Click option decorator: Workflow template variable value to be substituted in to the template file or string.
js_parallelism_option(f)	Click option decorator: If True, allow multiple jobscripts to execute simultaneously.
wait_option(f)	Click option decorator: If True, this command will block until the workflow execution is complete.
add_to_known_opt(f)	Click option decorator: If True, add this submission to the known-submissions file.
print_idx_opt(f)	Click option decorator: If True, print the submitted jobscript indices for each submission index.
tasks_opt(f)	Click option decorator: List of comma-separated task indices to include in this submission.
cancel_opt(f)	Click option decorator: Immediately cancel the submission.
submit_status_opt(f)	Click option decorator: If True, display a live status to track submission progress.
make_status_opt(f)	Click option decorator: If True, display a live status to track workflow creation progress.
zip_path_opt(f)	Click option decorator: Path at which to create the new zipped workflow.
zip_overwrite_opt(f)	Click option decorator: If set, any existing file will be overwritten.
zip_log_opt(f)	Click option decorator: Path to a log file to use during zipping.
zip_include_execute_opt(f)
zip_include_rechunk_backups_opt(f)
unzip_path_opt(f)	Click option decorator: Path at which to create the new unzipped workflow.
unzip_log_opt(f)	Click option decorator: Path to a log file to use during unzipping.
rechunk_backup_opt(f)	Click option decorator: First copy a backup of the array to a directory ending in .bak.
rechunk_chunk_size_opt(f)	Click option decorator: New chunk size (array items per chunk).
rechunk_status_opt(f)	Click option decorator: If True, display a live status to track rechunking progress.

Functions

sub_tasks_callback

Parse subtasks.