kappa_sdk.IncrementalPTA#

class kappa_sdk.IncrementalPTA(field_id, well_id, user_task_id, name, output_documents, script_instance_id, container_id, cluster_apis)[source]#

Incremental PTA object.

Presents a KAPPA Automate incremental PTA workflow object.

Attributes

`IncrementalPTA.container_id`	Gets the id of the associated well properties container
`IncrementalPTA.id`	Gets the id of the `IncrementalPTA` object.
`IncrementalPTA.minimum_shutin_duration`	Get the minimum shutin duration used to run the incremental PTA workflow
`IncrementalPTA.name`	Gets the name of the `IncrementalPTA`.
`IncrementalPTA.output_documents`	Gets the list of output documents of the `IncrementalPTA`.
`IncrementalPTA.pressure_vector_id`	Gets the vector id of the pressures used by the incremental pta
`IncrementalPTA.replicate_results_to_master`
`IncrementalPTA.shutin_vector_id`	Gets the vector id of the shut-in used by the incremental pta

Methods

IncrementalPTA.get_automation_status()

Get the automation status

Parameters:

field_id (str)
well_id (str)
user_task_id (str)
name (str)
output_documents (List[Document])
script_instance_id (str)
container_id (str)
cluster_apis (ClusterAPIS)

__init__(field_id, well_id, user_task_id, name, output_documents, script_instance_id, container_id, cluster_apis)[source]#

Parameters:

field_id (str)
well_id (str)
user_task_id (str)
name (str)
output_documents (List[Document])
script_instance_id (str)
container_id (str)
cluster_apis (ClusterAPIS)

property id: str#: Gets the id of the IncrementalPTA object.

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

property output_documents: List[Document]#: Gets the list of output documents of the IncrementalPTA.

property minimum_shutin_duration: float#: Get the minimum shutin duration used to run the incremental PTA workflow

property container_id: str#: Gets the id of the associated well properties container

property pressure_vector_id: str#: Gets the vector id of the pressures used by the incremental pta

property shutin_vector_id: str#: Gets the vector id of the shut-in used by the incremental pta

property replicate_results_to_master: bool#

get_automation_status()[source]#

Get the automation status

Returns:: AutomationStatus – Automation status
Return type:: AutomationStatus