kappa_sdk.user_tasks.simulation.SimulatedUserTask#

class kappa_sdk.user_tasks.simulation.SimulatedUserTask(well, name, outputs, well_property_container, well_group=None)[source]#

User task object.

Presents a KAPPA Automate user task information object.

Attributes

`SimulatedUserTask.documents`	Gets the list of the documents under this `UserTask`.
`SimulatedUserTask.files`	Gets the list of the files under this `UserTask`.
`SimulatedUserTask.id`	Gets the id of the `UserTask` object
`SimulatedUserTask.inputs`	Retrieves the user task inputs.
`SimulatedUserTask.name`	Gets the name of the `UserTask`.
`SimulatedUserTask.outputs`	Gets the list of outputs of the `UserTask`.
`SimulatedUserTask.plots`	Gets the list of the plot instances of the `UserTask`.
`SimulatedUserTask.user_task_definition_name`	Gets the user task definition name of the `UserTask` object.
`SimulatedUserTask.user_task_instance_id`	Gets the user task id (processing service) of the `UserTask` object.
`SimulatedUserTask.well_property_container_id`	Retrieves the user task well property container id.
`SimulatedUserTask.workflow_id`	Get the custom workflow id of the `UserTask` object.

Methods

`SimulatedUserTask.create_plot`(plot_name[, ...])	Create a Kappa Automate Plot instance under the user task.
`SimulatedUserTask.delete`()	Delete the User Task
`SimulatedUserTask.rename`(new_name)	Rename the User Task
`SimulatedUserTask.upload_file`(file_path[, ...])	Uploads a file to this `User Task`.

Parameters:

well (Well)
name (str)
outputs (List[Data])
well_property_container (str)
well_group (WellGroup | None)

__init__(well, name, outputs, well_property_container, well_group=None)[source]#

Parameters:

well (Well)
name (str)
outputs (List[Data])
well_property_container (str)
well_group (WellGroup | None)

create_plot(plot_name, pane_name=None, square_log_cycles=False, stacked_bars=False, x_label='', is_x_log=False, labels=None)[source]#

Create a Kappa Automate Plot instance under the user task. Creates under the well in Simulation mode.

Parameters:

plot_name (str) – Name of plot
pane_name (str | None) – Name of the pane
square_log_cycles (bool) – Whether or not use Square log cycles
stacked_bars (bool) – Whether or not use stacked bars
x_label (str) – x label
is_x_log (bool) – Whether or not use logarithmic scale for x values
labels (List[str] | None) – Add some labels to the plot

Returns:

Plot – The new Plot instance created under the task.

Return type:

Plot

property plots: List[Plot]#: Gets the list of the plot instances of the UserTask.

property files: List[File]#: Gets the list of the files under this UserTask.

property documents: List[Document]#: Gets the list of the documents under this UserTask.

property outputs: List[Data]#: Gets the list of outputs of the UserTask.

rename(new_name)[source]#

Rename the User Task

Parameters:: new_name (str)
Return type:: None

delete()[source]#

Delete the User Task

Return type:: None

property user_task_instance_id: None#: Gets the user task id (processing service) of the UserTask object. Since we are in simulation mode it is None

property name: str#: Gets the name of the UserTask.

property id: str#: Gets the id of the UserTask object

property workflow_id: str | None#: Get the custom workflow id of the UserTask object. Since we are in simulation mode it is None

property user_task_definition_name: None#: Gets the user task definition name of the UserTask object.

property inputs: None#: Retrieves the user task inputs. Returns None in simulation mode

property well_property_container_id: str#: Retrieves the user task well property container id.

upload_file(file_path, overwrite=False)[source]#

Uploads a file to this User Task. Upload it under the well in Simulation mode.

Parameters:

file_path (str) – Full path and name of the file to upload.
overwrite (bool) – A value indicating whether to overwrite a file with the same name if it already exists in the well.

Returns:

File – An uploaded file object.

Return type:

File