kappa_sdk.WellGroup#

class kappa_sdk.WellGroup(context, name, uwi, datum, wells, file_folders, pvts, files, user_tasks, well_group_dto_converter, data_types_catalog, well_properties_catalog, cluster_apis)[source]#

Well group object.

Presents a KAPPA Automate well group information object.

Attributes

`WellGroup.context`	Get the context of the `WellGroup` object.
`WellGroup.datum`	Gets the Datum of the `WellGroup` object.
`WellGroup.documents`	Gets the list of KW documents contained in this `Field`.
`WellGroup.file_folders`	Gets the list of file folders contained in this `WellGroup`.
`WellGroup.files`	Gets the list of files contained in this `WellGroup`.
`WellGroup.id`	Gets the id of the `WellGroup` object.
`WellGroup.name`	Gets the name of the `WellGroup`.
`WellGroup.pvts`	Gets the list of PVTs contained in this `WellGroup`.
`WellGroup.user_tasks`	Gets the list of user tasks contained in this `WellGroup`.
`WellGroup.uwi`	Gets the UWI of the `WellGroup` object.
`WellGroup.wells`	Gets the list of all wells contained in the `WellGroup`, including contained in the sub-well groups.

Methods

`WellGroup.create_pvt_from_file`(pvt_name, ...)	Creates a PVT (Pressure-Volume-Temperature) object from a file.
`WellGroup.create_pvt_from_kw_document`(...)	Create a PVT object in the well group from a KW document
`WellGroup.create_well`(name[, uwi, comment, ...])	Create a new well under the field associated to this `WellGroup`
`WellGroup.upload_file`(file_path[, ...])	Uploads a file to this `WellGroup`.

Parameters:

context (KAContext)
name (str)
uwi (str | None)
datum (float | None)
wells (List[Well])
file_folders (List[FileFolder])
pvts (List[PVT])
files (List[File])
user_tasks (List[UserTask])
well_group_dto_converter (WellGroupDtoConverter)
data_types_catalog (FieldDataTypesCatalog)
well_properties_catalog (FieldWellPropertiesCatalog)
cluster_apis (ClusterAPIS)

__init__(context, name, uwi, datum, wells, file_folders, pvts, files, user_tasks, well_group_dto_converter, data_types_catalog, well_properties_catalog, cluster_apis)[source]#

Parameters:

context (KAContext)
name (str)
uwi (str | None)
datum (float | None)
wells (List[Well])
file_folders (List[FileFolder])
pvts (List[PVT])
files (List[File])
user_tasks (List[UserTask])
well_group_dto_converter (WellGroupDtoConverter)
data_types_catalog (FieldDataTypesCatalog)
well_properties_catalog (FieldWellPropertiesCatalog)
cluster_apis (ClusterAPIS)

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

property context: KAContext#: Get the context of the WellGroup object.

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

property uwi: str | None#: Gets the UWI of the WellGroup object.

property datum: float | None#: Gets the Datum of the WellGroup object.

property wells: List[Well]#: Gets the list of all wells contained in the WellGroup, including contained in the sub-well groups.

property file_folders: List[FileFolder]#: Gets the list of file folders contained in this WellGroup.

Note

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

property pvts: List[PVT]#: Gets the list of PVTs contained in this WellGroup.

Note

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

property files: List[File]#: Gets the list of files contained in this WellGroup.

property documents: List[Document]#: Gets the list of KW documents contained in this Field.

property user_tasks: List[UserTask]#: Gets the list of user tasks contained in this WellGroup.

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

Uploads a file to this WellGroup.

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 group.
file_folder_id (str | None) – Id of the file folder to upload the file

Returns:

File – An uploaded file object.

Return type:

File

create_well(name, uwi=None, comment=None, production_type=WellProductionTypeEnum.unknown, labels=None, well_properties_values=None)[source]#

Create a new well under the field associated to this WellGroup

Parameters:

name (str) – Name of the new well
uwi (str | None) – Unique well identifier of the new well
comment (str | None) – Any description
production_type (WellProductionTypeEnum) – Production type of the new well, unknow by default
labels (List[str] | None) – Labels of the new well
well_properties_values (List[Dict[str, Any]] | None) – You can fill the well properties values, it has to be a dictionary following this format {‘alias_of_the_well_property’:value}

Returns:

Well – The new well

Return type:

Well

create_pvt_from_file(pvt_name, file_id, pvt_format, start_date=None, reservoir_pressure=None, reservoir_temperature=None, gas_oil_type=None, unit_system=None)[source]#

Creates a PVT (Pressure-Volume-Temperature) object from a file. You can define fallback parameters when the gas oil type is undetermined.

Parameters:

pvt_name (str) – The name of the PVT object to be created.
file_id (str) – The identifier of the file from which the PVT object will be created.
pvt_format (PVTFormatEnum) – Format of the PVT document
start_date (datetime, optional) – The start date for the PVT data coverage. Defaults to None.
reservoir_pressure (float, optional) – The pressure of the reservoir associated with the PVT object. Defaults to None.
reservoir_temperature (float, optional) – The temperature of the reservoir associated with the PVT object. Defaults to None.
gas_oil_type (GasOilTypeEnum, optional) – The type of gas or oil associated with the PVT object, as per the enumerated GasOilTypeEnum. Defaults to None.
unit_system (UnitSystemPvtEnum, optional) – The unit system used for the PVT object, as per the enumerated UnitSystemPvtEnum. Defaults to None.

Returns:

PVT – An instance of the PVT object created using the provided parameters and data from the specified text file.

Return type:

PVT

create_pvt_from_kw_document(pvt_name, document_id, analysis_id)[source]#

Create a PVT object in the well group from a KW document

Parameters:

pvt_name (str) – Name of the PVT object to create
document_id (str) – Id of the document to use
analysis_id (str) – Id of the analysis to use

Returns:

PVT – The PVT object created.

Return type:

PVT