kappa_sdk.WellGroup#

class kappa_sdk.WellGroup(well_group_id, field_id, name, cluster_apis, uwi, file_folders, pvts, well_group_dto_converter, data_types_catalog, well_properties_catalog)[source]#

Well group object.

Presents a KAPPA Automate well group information object.

Attributes

WellGroup.file_folders

Gets the list of file folders 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.uwi

Gets the UWI of the WellGroup object.

Methods

WellGroup.create_pvt_from_file(pvt_name, file_id)

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:

  • well_group_id (str)

  • field_id (str)

  • name (str)

  • cluster_apis (ClusterAPIS)

  • uwi (str | None)

  • file_folders (List[FileFolder])

  • pvts (List[PVT])

  • well_group_dto_converter (WellGroupDtoConverter)

  • data_types_catalog (FieldDataTypesCatalog)

  • well_properties_catalog (FieldWellPropertiesCatalog)

__init__(well_group_id, field_id, name, cluster_apis, uwi, file_folders, pvts, well_group_dto_converter, data_types_catalog, well_properties_catalog)[source]#
Parameters:

  • well_group_id (str)

  • field_id (str)

  • name (str)

  • cluster_apis (ClusterAPIS)

  • uwi (str | None)

  • file_folders (List[FileFolder])

  • pvts (List[PVT])

  • well_group_dto_converter (WellGroupDtoConverter)

  • data_types_catalog (FieldDataTypesCatalog)

  • well_properties_catalog (FieldWellPropertiesCatalog)

property id: str#

Gets the id 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 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.

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, 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.

  • 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