workflow¶

Workflow commands.

fractal workflow [-h]
        {list,new,show,edit,delete,add-task,edit-task,rm-task,import,export}
        ...

Sub-commands¶

workflow list¶

List workflows for given project.

fractal workflow list [-h] project_id

Positional Arguments¶

project_id: Project ID.

workflow new¶

Create new workflow.

fractal workflow new [-h] name project_id

Positional Arguments¶

name: Workflow name (must be unique, and not only made of numbers only).
project_id: Project ID.

workflow show¶

Show workflow.

fractal workflow show [-h] project_id workflow_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.

workflow edit¶

Edit workflow.

fractal workflow edit [-h] --new-name NEW_NAME project_id workflow_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.

Named Arguments¶

--new-name: New workflow name.

workflow delete¶

Delete workflow.

fractal workflow delete [-h] project_id workflow_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.

workflow add-task¶

Add new task to specific workflow.

fractal workflow add-task [-h]  (--task-id TASK_ID | --task-name TASK_NAME)
        [--task-version TASK_VERSION]  [--order ORDER]  [--args-non-parallel
        ARGS_NON_PARALLEL]  [--args-parallel ARGS_PARALLEL]
        [--meta-non-parallel META_NON_PARALLEL]  [--meta-parallel META_PARALLEL]
        [--input-filters INPUT_FILTERS]  project_id workflow_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.

Named Arguments¶

--task-id: ID of the task to add.
--task-name: Name of the task to add.
--task-version: Version of task to add (only accepted in combination with --task-name).
--order: Order of this task within the workflow's task list.
--args-non-parallel: Args for non parallel tasks
--args-parallel: Args for parallel tasks
--meta-non-parallel: Metadata file fornon parallel tasks
--meta-parallel: Metadata file for parallel tasks
--input-filters: Path to json file with filters.

workflow edit-task¶

Edit task within specific workflow.

fractal workflow edit-task [-h] [--input-filters INPUT_FILTERS]
        [--args-non-parallel ARGS_NON_PARALLEL]  [--args-parallel ARGS_PARALLEL]
        [--meta-non-parallel META_NON_PARALLEL]  [--meta-parallel META_PARALLEL]
        project_id workflow_id workflow_task_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.
workflow_task_id: Workflow task ID, the ID of a task inside the list of tasks.

Named Arguments¶

--input-filters: Path to json serialised file containing the arguments overrides of the task.
--args-non-parallel: Args for non parallel tasks
--args-parallel: Args for parallel tasks
--meta-non-parallel: Metadata file fornon parallel tasks
--meta-parallel: Metadata file for parallel tasks

workflow rm-task¶

Remove task from a specific workflow.

fractal workflow rm-task [-h] project_id workflow_id workflow_task_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.
workflow_task_id: Workflow task ID (the ID of a task inside the list of tasks).

workflow import¶

Import workflow to project from file.

fractal workflow import [-h] --project-id PROJECT_ID --json-file  JSON_FILE
        [--workflow-name WORKFLOW_NAME]

Named Arguments¶

--project-id: ID of the project where the workflow will be imported.
--json-file: Path to a JSON file with the workflow to be imported.
--workflow-name: Name of the new workflow (if set, overrides the one in JSON file)

workflow export¶

Export workflow to file.

fractal workflow export [-h] --json-file JSON_FILE  project_id workflow_id

Positional Arguments¶

project_id: Project ID.
workflow_id: Workflow ID.

Named Arguments¶

--json-file: Path to the JSON file where the workflow will be exported.