kappa_sdk.Field#

class kappa_sdk.Field(field_id, name, asset, field_dto, cluster_apis, dto_converter)[source]#

Field object.

Presents a KAPPA Automate field object that can be queried for contained wells. Returned as a result of the Connection.get_fields() query.

Note

Should not be instantiated directly.

Note

Field.wells property is populated on-demand and is cached for the duration of the Connection.

Attributes

`Field.asset`	Gets the asset of the `Field`.
`Field.data_types_catalog`	Get the Field Data Types catalog object of the `Field`
`Field.documents`	Gets the list of KW documents contained in this `Field` and its well groups.
`Field.file_folders`	Gets the list of file folders contained in this `Well`.
`Field.files`	Gets the list of files contained in this `Field` and its well groups.
`Field.id`	Gets the id of the `Field` object.
`Field.name`	Gets the name of the `Field`.
`Field.pvts`	Gets the list of PVTs contained in this `Field`.
`Field.reference_date`	Gets the reference date of the `Field`.
`Field.well_groups`	Gets the list of all well groups contained in the `Field`.
`Field.well_properties_catalog`	Get the Field Well Properties catalog object of the `Field`
`Field.wells`	Gets the list of all wells contained in the `Field`, including contained in the well groups.

Methods

`Field.create_automatic_rtm_aggregator`(...[, ...])
`Field.create_pvt_from_file`(pvt_name, file_id)	Creates a PVT (Pressure-Volume-Temperature) object from a file.
`Field.create_pvt_from_kw_document`(pvt_name, ...)	Create a PVT object in the well group from a KW document
`Field.create_well`(name[, uwi, comment, ...])	Create a new well under the field associated to this `Field`
`Field.delete`()	Delete the field
`Field.refresh_data`()	Clean all attributes and dto, to grab updated attributes.
`Field.rename`(new_name)	Rename the field :param new_name: New name of the field
`Field.upload_file`(file_path[, ...])	Uploads a file to this `Field`.

Parameters: