kappa_sdk.ProductionFolder#

class kappa_sdk.ProductionFolder(field_id, well_id, id, name, phases, production_folder_type, dto_converter, cluster_apis)[source]#

Attributes

ProductionFolder.data

Gets the list of data contained in this ProductionFolder.

ProductionFolder.gas

The gas data contains in the raw production folder, returns None if there is no production gauge available :returns: Optional[Data] (Gas data)

ProductionFolder.id

The id of the production folder :returns: str (id of the production folder)

ProductionFolder.name

The name of the production folder :returns: str (name of the production folder)

ProductionFolder.oil

The oil data contains in the production folder, returns None if there is no production gauge available :returns: Optional[Data] (Oil data)

ProductionFolder.type

Get the type of Production Folder

ProductionFolder.water

The water data contains in the raw production folder, returns None if there is no production gauge available :returns: Optional[Data] (water Data)

Methods

ProductionFolder.load_production_gauge(...)

Load a production gauge.
Parameters:

  • field_id (str)

  • well_id (str)

  • id (str)

  • name (str)

  • phases (List[Data])

  • production_folder_type (ProductionFolderKindEnum)

  • dto_converter (ProductionFolderDtoConverter)

  • cluster_apis (ClusterAPIS)

__init__(field_id, well_id, id, name, phases, production_folder_type, dto_converter, cluster_apis)[source]#
Parameters:

  • field_id (str)

  • well_id (str)

  • id (str)

  • name (str)

  • phases (List[Data])

  • production_folder_type (ProductionFolderKindEnum)

  • dto_converter (ProductionFolderDtoConverter)

  • cluster_apis (ClusterAPIS)

property id: str#

The id of the production folder :returns: str (id of the production folder)

property name: str#

The name of the production folder :returns: str (name of the production folder)

property oil: Data | None#

The oil data contains in the production folder, returns None if there is no production gauge available :returns: Optional[Data] (Oil data)

property gas: Data | None#

The gas data contains in the raw production folder, returns None if there is no production gauge available :returns: Optional[Data] (Gas data)

property water: Data | None#

The water data contains in the raw production folder, returns None if there is no production gauge available :returns: Optional[Data] (water Data)

property data: List[Data]#

Gets the list of data contained in this ProductionFolder.

property type: ProductionFolderKindEnum#

Get the type of Production Folder

load_production_gauge(datasource_name, datasource_gauge_name, dimension, data_type, unit, time_format, gauge_name=None, children_datasource_names=None, last_step_duration_hours=None, is_high_frequency=True, gauge_model='', measure_depth=0, true_vertical_depth=0, true_vertical_depth_sub_sea=0, serial_number='', labels=None, comment='', read_from=None, read_to=None)[source]#

Load a production gauge.

Parameters:

  • datasource_name (str) – name of the datasource

  • datasource_gauge_name (str) – name of the gauge in the datasource

  • dimension (MeasureEnum) – Measure of the gauge

  • data_type (str) – Type of the gauge data

  • unit (UnitEnum) – Unit to load the gauge data

  • time_format (TimeFormatEnum) – time format of the gauge data, could be points, time at start or time at end

  • gauge_name (str | None) – Name of the gauge that will be created under the well, if None then it will use the name of the gauge under the datasource

  • children_datasource_names (List[str] | None) – Names of the different sub-datasources, could be None if there is no sub-datasources

  • last_step_duration_hours (float | None) – Last step duration in hours

  • is_high_frequency (bool) – Enable it if you have high frequency data

  • gauge_model (str) – Type of the gauge

  • measure_depth (float) – Depth of the gauge, must be converted to internal units, use convert_to_internal method from kappa_sdk.UnitConverter to do so

  • true_vertical_depth (float) – TVD of the gauge, must be converted to internal units, use convert_to_internal method from kappa_sdk.UnitConverter to do so

  • true_vertical_depth_sub_sea (float) – TVDss of the gauge, must be converted to internal units, use convert_to_internal method from kappa_sdk.UnitConverter to do so

  • serial_number (str) – Serial number of the gauge

  • labels (List[str] | None) – Add custom labels to the gauge

  • comment (str) – Add any comment to the gauge description

  • read_from (datetime | None) – start date to read the data

  • read_to (datetime | None) – end data to read the data

Return type:

Data