kappa_sdk.Document#

class kappa_sdk.Document(field_id, well_group_id, well_id, custom_workflow_id, file_id, name, module_type, parent_ipta, labels, cluster_apis, document_dto_converter)[source]#

KW document object.

Presents a KW document that can be queried for contained analyses and results.

Note

Should not be instantiated directly.

Note

Document.analyses property is populated on-demand and is cached for the duration of the Connection.

If you need to get actual values, use the Document.update_analyses() method.

Attributes

Document.analyses

Gets the list of analyses contained in this document that has log-log data inside.

Document.analysis_results

Returns a wrapper for the "resultsSI.xml" in this document.

Document.file_id

Gets the id of the KW Document file.

Document.labels

Gets the list of labels of the KA Document.

Document.name

Gets the name of the KW Document.

Document.parent_ipta

Gets the parent ipta of the KW Document file.

Document.type

Gets the type of the KW module for this Document.

Document.well_group_id

Gets the well_group_id of the KA File.

Methods

Document.add_labels(labels)

Add labels to this document

Document.copy([new_name, field_id, well_id, ...])

Copy this document to the current file folder or to another field/well file folder

Document.copy_analysis(...)

Copy the current Analysis from the document

Document.delete()

Delete the current document

Document.delete_analyses(analysis_names)

Delete analyses from the document :param analysis_names: Name of analyses to delete

Document.get_artm_parameters()

Document.get_improve_parameters()

Get improve parameters to run an IPTA or IRTA

Document.get_log_log_data()

Get all loglog plots from all analyses in the document

Document.get_model_book_parameters()

Document.get_model_xml([action])

Returns analysis model definition(s) in KW-KA exchange XML format for all analyses in the document.

Document.get_pseudo_pressures(pressure_id[, ...])

Calculate pseudo-pressures from pressures

Document.get_results_xml()

Returns the content of the "resultsSI.xml" in this document.

Document.get_results_xml_legacy()

Returns the content of the "results.xml" in this document.

Document.get_well_intake_template_xml(...)

Get a well intake template xml :param intake_type: :type intake_type: Well intake type

Document.refresh_analyses()

Refresh the cached value of the Document.analyses property.

Document.rename(name)

Rename this document

Document.reset_pressure(pressure_id)

Reset pressures values

Document.reset_rate(rates_id, rate_type)

Reset rates values

Document.run_kw_script(script[, ...])

Runs a KW script.

Document.set_model_xml(model_xml[, action])

Applies given analysis model definition(s) in KW-KA exchange XML format to the document.

Document.update_models_parameters(...[, ...])

Update all xml model in the document
Parameters:

  • field_id (str)

  • well_group_id (str | None)

  • well_id (str | None)

  • custom_workflow_id (str | None)

  • file_id (str)

  • name (str)

  • module_type (KWModuleEnum)

  • parent_ipta (str | None)

  • labels (List[str])

  • cluster_apis (ClusterAPIS)

  • document_dto_converter (DocumentDtoConverter)

On this page