kappa_sdk.Well#

class kappa_sdk.Well(field_id, well_group_id, well_id, name, uwi, data_types_catalog, well_properties_catalog, cluster_apis, dto_converter)[source]#

Well object.

Presents a KAPPA Automate well object that can be queried for contained data, documents and every existing object under the well. Returned as a result of the Field.wells query.

Note

Should not be instantiated directly.

Note

Well.data, Well.shutin, and Well.documents properties are populated on-demand and are cached for the duration of the Connection.

Attributes

`Well.corrected_production_folders`	Gets the corrected production folders that contains this `Well`.
`Well.corrected_productions`	Gets the list of corrected production phases contained in this `Well`.
`Well.custom_workflows`	Gets the list of custom workflows contained in this `Well`.
`Well.data`	Gets the list of data contained in this `Well`.
`Well.data_folders`	Gets the list of data folders contained in this `Well`.
`Well.documents`	Gets the list of KW documents contained in this `Well`.
`Well.field_id`	Gets the id of the field that contains this `Well`.
`Well.file_folders`	Gets the list of file folders contained in this `Well`.
`Well.files`	Gets the list of files contained in this `Well`.
`Well.filters`	Gets the list of filters contained in this `Well`.
`Well.functions`	Gets the list of functions contained in this `Well`.
`Well.gauges`	Gets the list of gauges contained in this `Well`.
`Well.id`	Gets the id of the `Well` object.
`Well.incremental_pta_workflows`	Gets the list of incremental PTA workflows contained in this `Well`.
`Well.incremental_rta_workflows`	Gets the list of incremental RTA workflows contained in this `Well`.
`Well.labels`	Gets the labels of the `Well` object.
`Well.model_books`	Gets the list of model book contained in this `Well`.
`Well.name`	Gets the name of the `Well`.
`Well.plots`	Gets the list of plots contained in this `Well`.
`Well.production_folders`	Gets the raw production folders that contains this `Well`.
`Well.production_type`	Returns the production type of the well
`Well.productions`	Gets the list of production phases contained in this `Well`.
`Well.pvts`	Gets the list of PVTs contained in this `Well`.
`Well.shut_in`	Gets the shut-in data for this `Well`.
`Well.surveys`	Gets the list of surveys contained in this `Well`.
`Well.user_tasks`	Gets the list of user tasks contained in this `Well`.
`Well.uwi`	Gets the UWI of the `Well` object.
`Well.well_group_id`	Gets the well group id that contains this `Well`.
`Well.well_logs`	Gets the list of well log contained in this `Well`.
`Well.well_property_containers`	Gets the list of well property containers contained in this `Well`.
`Well.wellbore`	Gets the wellbore of the `Well` object.

Methods

`Well.compute_forward_rates`(pvt_id, ...[, ...])	Computes forward rates based on well and reservoir parameters, including pressure, temperature, velocity vs depth, and optional reservoir properties.
`Well.copy_file`(file[, new_name, field_id, ...])	Copy this document to the current file folder or to another field/well file folder
`Well.create_corrected_production`(...[, ...])	Creates a corrected production dataset based on the given parameters.
`Well.create_data`(name, data_type[, labels, ...])	Creates and returns a new data object with specified parameters.
`Well.create_data_folder`(name[, ...])	Creates a data folder within the current context, either as a direct child of a parent folder or at the well level, depending on the specified parameters.
`Well.create_document`(document_type, ...[, ...])
`Well.create_file_folder`(name[, folder_parent_id])	Creates a new file folder within the specified parent folder or within the default parent folder if none is specified.
`Well.create_filter`(data, filter_type[, ...])	Create a wavelet filter under the gauge associated to this `Data` object.
`Well.create_incremental_pta`(name, ...[, ...])	Create an incremental pta workflow
`Well.create_incremental_rta`(name, ...[, ...])	Create an incremental rta workflow
`Well.create_model_book`(document, name)	Creates a new model book associated with this well.
`Well.create_plot`(plot_name[, pane_name, ...])	Create a Kappa Automate Plot instance under the well
`Well.create_production_folder`(name)	Creates a new production folder in the well :param name: :type name: `The name` of `the production folder`
`Well.create_pvt_from_file`(pvt_name, file_id)	Creates a PVT (Pressure-Volume-Temperature) object from a file.
`Well.create_pvt_from_kw_document`(pvt_name, ...)	Create a pvt object in the well
`Well.create_shut_in`(input_type, input_gauge, ...)	Creates a shut-in event based on the given parameters.
`Well.create_step_data`(name, data_type, first_x)	Creates and initializes a step data object with the provided parameters.
`Well.create_survey`(name, date)	Create a new survey in the well.
`Well.create_well_property_container`(name)	Creates a new well property container for this `Well`.
`Well.create_wellbore`(geometries[, ...])	Creates or updates a wellbore with the specified geometries and perforations.
`Well.delete_data`(data)	Deletes a specified data object from the current field and updates the internal data list by removing the corresponding object.
`Well.delete_file`(file)	Deletes a specified file from the cluster and updates the local file list.
`Well.delete_model_book`(model_book)	Deletes a model book from this well.
`Well.delete_survey`(survey)
`Well.delete_wellbore`()	Deletes the current wellbore if the well has one.
`Well.extract_well_properties_from_document`(...)	Extracts well properties from a given document.
`Well.find_gauge_by_id`(vector_id)	Finds a gauge by id.
`Well.find_gauge_by_type`(data_type[, label, ...])	Finds the first matching gauge by data-type and/or label.
`Well.get_shut_in_extractions`(...[, ...])	Extract a loglog given the shut-in dates, pressure gauge and a corrected rate gauge.
`Well.load_gauge`(datasource_name, ...[, ...])	Loads a gauge with the provided attributes into the system.
`Well.refresh_data`()	Clean all the well attributes and dto from the cache, to grab updated attributes.
`Well.rename`(new_well_name)	Rename the current well object.
`Well.upload_file`(file_path[, ...])	Uploads a file to this `Well`.

Parameters:

field_id (str)
well_group_id (str | None)
well_id (str)
name (str)
uwi (str | None)
data_types_catalog (FieldDataTypesCatalog)
well_properties_catalog (FieldWellPropertiesCatalog)
cluster_apis (ClusterAPIS)
dto_converter (WellDtoConverter)