kappa_sdk.WellPropertyContainer#

class kappa_sdk.WellPropertyContainer(field_id, well_id, well_property_container_id, name, well_properties_catalog, labels, is_master, cluster_apis, dto_converter)[source]#

Well property container object.

Presents a KAPPA Automate well property container object.

Attributes

WellPropertyContainer.id

Gets the id of the WellPropertyContainer object.

WellPropertyContainer.is_master

Gets a value indicating whether this contains is a master one.

WellPropertyContainer.labels

Gets the labels of the WellPropertyContainer object.

WellPropertyContainer.name

Gets the name of the WellPropertyContainer.

Methods

WellPropertyContainer.add_well_property_values(...)

WellPropertyContainer.delete_well_property_values(...)

Deletes values of a given well property for a given range in this WellPropertyContainer, all values will be deleted if from_time and to_time are undefined.

WellPropertyContainer.get_well_properties([...])

Gets a dictionary of alias/value pairs for all well properties in this WellPropertyContainer.

WellPropertyContainer.get_well_property_values(...)

Gets a vector of values for a given well property from this WellPropertyContainer.

WellPropertyContainer.set_well_property_value(...)

Sets a value for a well property.
Parameters:

  • field_id (str)

  • well_id (str)

  • well_property_container_id (str)

  • name (str)

  • well_properties_catalog (FieldWellPropertiesCatalog)

  • labels (List[str])

  • is_master (bool)

  • cluster_apis (ClusterAPIS)

  • dto_converter (WellPropertyDtoConverter)

__init__(field_id, well_id, well_property_container_id, name, well_properties_catalog, labels, is_master, cluster_apis, dto_converter)[source]#
Parameters:

  • field_id (str)

  • well_id (str)

  • well_property_container_id (str)

  • name (str)

  • well_properties_catalog (FieldWellPropertiesCatalog)

  • labels (List[str])

  • is_master (bool)

  • cluster_apis (ClusterAPIS)

  • dto_converter (WellPropertyDtoConverter)

property id: str#

Gets the id of the WellPropertyContainer object.

property name: str#

Gets the name of the WellPropertyContainer.

property is_master: bool#

Gets a value indicating whether this contains is a master one.

property labels: List[str]#

Gets the labels of the WellPropertyContainer object.

get_well_properties(validity_date=None)[source]#

Gets a dictionary of alias/value pairs for all well properties in this WellPropertyContainer.

Parameters:

validity_date (datetime | None) – The validity date of values. If not specified, latest values will be returned.

Return type:

Dict[str, Any]

get_well_property_values(well_property_alias, from_time=None, to_time=None, count=-1, last=False, unit=None)[source]#

Gets a vector of values for a given well property from this WellPropertyContainer.

Parameters:

  • well_property_alias (str) – The alias of the well property.

  • from_time (datetime | None) – Date to start reading from.

  • to_time (datetime | None) – Date to read the data up to.

  • count (int) – Maximum count of points to return, regardless of from/to settings.

  • last (bool) – Will return last (count) of points if set to true.

  • unit (UnitEnum | None) – Convert values from internal units to a specific unit.

Returns:

Vector – Vector that contains the requested data values.

Return type:

Vector

delete_well_property_values(well_property_alias, from_time=None, to_time=None)[source]#

Deletes values of a given well property for a given range in this WellPropertyContainer, all values will be deleted if from_time and to_time are undefined.

Parameters:

  • well_property_alias (str) – The alias of well property to update.

  • from_time (datetime | None) – The date from where values have to be removed, can be None

  • to_time (datetime | None) – The date until where values have to be removed, can be None

Return type:

None

set_well_property_value(well_property_alias, value, timestamp=None, is_step_at_start=True, first_x=None)[source]#

Sets a value for a well property.

This method sets the given value for a specified well property. If the property does not exist in the current set of well properties, it will be created using additional parameters. Otherwise, it updates the well property values based on the provided arguments.

Parameters:

  • well_property_alias (str) – Alias of the well property for which the value is to be set.

  • value (Optional[Union[str, bool, float]]) – Value to be set for the well property. The format and type of the value depend on the specific property.

  • timestamp (Optional[datetime], optional) – Timestamp at which the value is to be recorded. If not provided, the current UTC time will be used, by default None.

  • is_step_at_start (bool, optional) – Determines whether the step is at the start or end when recording the value, by default True.

  • first_x (Optional[datetime], optional) – Indicates the starting timestamp of the time series for the property, used when the well property does not yet exist, by default None, only used when you are in step at end.

Return type:

None

add_well_property_values(well_property_alias, dates, values, is_step_at_start=True, first_x=None)[source]#
Parameters:

  • well_property_alias (str)

  • dates (List[datetime])

  • values (List[float])

  • is_step_at_start (bool)

  • first_x (datetime | None)

Return type:

None