GlobalObservedDataSet

class cegalprizm.pythontool.GlobalObservedDataSet(petrel_object_link: GlobalObservedDataSetsGrpc)

A class holding information about a global observed data set

Functions

__init__(petrel_object_link)
add_comment(new_comment[, overwrite])	Add a comment to the already existing comments on the PetrelObject, or overwrite the existing comments.
clone(name_of_clone[, copy_values])	Creates a clone of the Petrel object.
create_observed_data_set(well)	Creates an observed data set for a well which is assigned to the global observed data set.
retrieve_history()	The Petrel history for the object.
retrieve_stats()	Retrieves a dictionary summarizing the statistics for the object

Properties

comments	The comments on the PetrelObject.
droid	The Petrel Droid (object id or guid) for the object
path	The path of this object in Petrel.
petrel_name	Returns the name of this object in Petrel
readonly	The read-only status of this object
template	Returns the Petrel template for the object as a string.

add_comment(new_comment: str, overwrite: bool = False) → None

Add a comment to the already existing comments on the PetrelObject, or overwrite the existing comments.

Input:

new_comment: The new comment to add to the PetrelObject. overwrite: Boolean flag to overwrite all existing comments with the new comment. Default is False.

Raises

PythonToolException – if object is read-only

clone(name_of_clone: str, copy_values: bool = False) → cegalprizm.pythontool.observeddata.GlobalObservedDataSet

Creates a clone of the Petrel object.

The clone is placed in the same collection as the source object. A clone cannot be created with the same name as an existing Petrel object in the same collection.

This is a Python Tool Pro function and is not available when running scripts in the editor integrated in Python Tool or in a workflow.

Parameters

path_of_clone – Petrel name of the clone

Returns

The clone

Return type

WellLog

Raises

• Exception – If there already exists a Petrel object with the same name

• ValueError – If name_of_clone is empty or contains slashes

create_observed_data_set(well: Well) → cegalprizm.pythontool.observeddata.ObservedDataSet

Creates an observed data set for a well which is assigned to the global observed data set.

Parameters

well (Well) – The well object for which the observed data set is to be created.

Returns

A cegalprizm.pythontool.ObservedDataSet object

Raises

ValueError – if the supplied input is not a Well object

retrieve_history() → pandas.core.frame.DataFrame

The Petrel history for the object.

Returns the Petrel history for the object as Pandas dataframe.

Returns

The history of the object as reported by Petrel

Return type

DataFrame

retrieve_stats() → Dict[str, str]

Retrieves a dictionary summarizing the statistics for the object

The statistics are a snapshot of the information in the Statistics page of the Settings panel of the object in the Petrel tree. Both the dict key and value are strings, and may contain punctuation, English phrases or just filler information. Any changes to the dict returned will not be saved or affect anything.

Note: this operation may be slow, since the statistics are ‘live’ - they represent the most up to date information.

Returns

The statistics of the object as reported by Petrel

Return type

dict

property comments

The comments on the PetrelObject.

Returns

The comments on the PetrelObject as a string.

Return type

string

property droid: str

The Petrel Droid (object id or guid) for the object

Returns the Petrel Droid or object id or guid for the object. If not available, will throw a PythonToolException.

This property is planned to be deprecated in favour of a similar but more general id schema in future releases.

Returns

The Petrel Droid of the object

Return type

str

property path: str

The path of this object in Petrel. Neither the Petrel name nor the path is guaranteed to be unique.

Returns

The path of the Petrel object

Return type

str

property petrel_name: str

Returns the name of this object in Petrel

property readonly: bool

The read-only status of this object

Returns

True if the object is read-only

Return type

bool

property template: str

Returns the Petrel template for the object as a string. If no template available, will return an empty string.