Task Creation Config

The Task Submission Config is used to submit completed tasks and it includes information about the task as well as scripts used to perform the task and any output locations of visualizations, reports, etc.

Curious to know more about how to submit a task? See the Create Tasks user guide.

TOML Example (Click to Expand)

# this is an example of the toml that is submitted WHEN A USER HAS COMPLETED TASKS AND WANTS TO NOTIFY PIPES

task_name = "check-wind"
type = "QAQC"                  # *required* must be one of [QAQC, Visualization, Transformation]
dataset_ids = ["load-profiles"]   # *optional* This is for datasets that live within the model run
vertex_ids = []  # *optional* If any datasets live outside of this model run, provide the vertex ids here
description = "Checked something"           # *required* describe the purpose of the task
notes = """"""                 # any info to store about the task (e.g., any issues etc.)
script = ["my_script.py"]  # the script used, provide the full path relative to the toml file
subtask_ids = ["check_wind"]                   # if performing preset tasks that PIPES knows about (e.g., transformations),
                           # please provide all ids of the tasks that were performed
                                       # to get a list of possible task ids, in the terminal type `some PIPES CLI command`
relates_to = [""]          # objects in PIPES this task relates to
[outputs] # optional
  location = "" # where is the output located if it is not going to be checked into PIPES
  # put any other information related to outputs below

Schema Definition

`schemas`

`TaskCreate`

Task creation schema.

Attributes:

Name	Type	Description
`name`	`str`	Task name, must be unique to this model run.
`type`	`str`	Task type, like QAQC, Transformation, or Visualization.
`description`	`str`	Description of task process.
`assignee`	`UserCreate \| EmailStr \| None`	The user who conducts this task.
`status`	`ExecutionStatus`	The task status - PENDING, RUNNING, SUCCESS, or FAILURE.
`subtasks`	`list[SubTask]`	List of actions under this task.
`scheduled_start`	`datetime \| None`	Scheduled start date.
`scheduled_end`	`datetime \| None`	Scheduled end date.
`completion_date`	`datetime \| None`	Task completion date.
`source_code`	`SourceCode \| None`	Scripts used to perform the task process.
`input_datasets`	`list[str]`	List of datasets that the task applies to.
`input_parameters`	`dict`	Non-dataset inputs, i.e. parameters in dictionary.
`output_datasets`	`list[str]`	List of datasets produced from this task.
`output_values`	`dict`	Non-dataset outputs, i.e. values in dictionary.
`logs`	`str`	Task log location.
`notes`	`str`	Notes and additional information.

Fields:

name (str)
type (str)
description (str)
assignee (UserCreate | EmailStr | None)
status (ExecutionStatus)
subtasks (list[SubTask])
scheduled_start (datetime | None)
scheduled_end (datetime | None)
completion_date (datetime | None)
source_code (SourceCode | None)
input_datasets (list[str])
input_parameters (dict)
output_datasets (list[str])
output_values (dict)
logs (str)
notes (str)

`assignee`

The user who conducts this task

`completion_date`

task completion date

`description`

description of task process

`input_datasets`

List of datasets that the task applies to.

`input_parameters`

Non-dataset inputs, i.e. parameters in dictionary

`logs`

task log location

`name`

task name, must be unique to this model run.

`notes`

notes and additional information

`output_datasets`

List of datasets produced from this task

`output_values`

non-dataset outputs, i.e. values in dictionary

`scheduled_end`

scheduled end date

`scheduled_start`

scheduled start date

`source_code`

Scripts used to perform the task process

`status`

The task status - PENDING, RUNNING, SUCCESS, or FAILURE

`subtasks`

List of actions under this task

`type`

task type, like be QAQC, Transformation, or Visualization