kappa_sdk.ShutIn#

class kappa_sdk.ShutIn(start_date, end_date, is_reference, pressure_id, shut_in_category, shut_in_type, rate_multiplier, comment, kw_api, vector_id=None, data_api=None)[source]#

Class to store any shutin

Attributes

`ShutIn.comment`	Returns the comment of the `ShutIn` object
`ShutIn.duration`	Returns the duration of the `ShutIn` object
`ShutIn.end_date`	Returns the end date of the `ShutIn` object
`ShutIn.fit_for_use`	Returns whether the ShutIn is fit for use or not, returns None if the category is Unknown
`ShutIn.hard_shutin`	Returns whether the ShutIn is an hard shutin or not, returns None if the type is Unknown
`ShutIn.is_reference`	Returns whether the ShutIn is reference or not
`ShutIn.rate_multiplier`	Returns the rate multiplier of the `ShutIn` object
`ShutIn.shut_in_category`	Returns the category of the `ShutIn` object
`ShutIn.shut_in_type`	Returns the type of the `ShutIn` object
`ShutIn.start_date`	Returns the start date of the `ShutIn` object

Methods

`ShutIn.get_log_log_preview_from_shut_in_dates`([...])	Get Loglog preview `DocumentVector` from shut-in dates :param pressure_id: Pressure vector id to use :param to_date: End date of the shut-in, if None it will use the initial end date of the shut-in :param tp: Horner Time on production
`ShutIn.update`([shut_in_category, ...])	Updates the attributes of this `ShutIn` and persists the change immediately.

Parameters:

start_date (datetime)
end_date (datetime)
is_reference (bool)
pressure_id (str | None)
shut_in_category (ShutInCategoriesEnum)
shut_in_type (ShutInTypesEnum)
rate_multiplier (float)
comment (str | None)
kw_api (KWAPI)
vector_id (str | None)
data_api (DataAPI | None)

__init__(start_date, end_date, is_reference, pressure_id, shut_in_category, shut_in_type, rate_multiplier, comment, kw_api, vector_id=None, data_api=None)[source]#

Parameters:

start_date (datetime)
end_date (datetime)
is_reference (bool)
pressure_id (str | None)
shut_in_category (ShutInCategoriesEnum)
shut_in_type (ShutInTypesEnum)
rate_multiplier (float)
comment (str | None)
kw_api (KWAPI)
vector_id (str | None)
data_api (DataAPI | None)

property start_date: datetime#: Returns the start date of the ShutIn object

property end_date: datetime#: Returns the end date of the ShutIn object

property is_reference: bool#: Returns whether the ShutIn is reference or not

property fit_for_use: bool | None#: Returns whether the ShutIn is fit for use or not, returns None if the category is Unknown

property hard_shutin: bool | None#: Returns whether the ShutIn is an hard shutin or not, returns None if the type is Unknown

property duration: timedelta#: Returns the duration of the ShutIn object

property rate_multiplier: float#: Returns the rate multiplier of the ShutIn object

property comment: str | None#: Returns the comment of the ShutIn object

property shut_in_category: ShutInCategoriesEnum#: Returns the category of the ShutIn object

property shut_in_type: ShutInTypesEnum#: Returns the type of the ShutIn object

update(shut_in_category=None, shut_in_type=None, rate_multiplier=None, comment=None, is_reference=None)[source]#

Updates the attributes of this ShutIn and persists the change immediately.

Only the arguments you provide are modified; the others are left unchanged. To clear an existing comment, pass an empty string.

The ShutIn must have been obtained through ShutInList.from_data().

Parameters:

shut_in_category (ShutInCategoriesEnum | None) – New ShutInCategoriesEnum (fit for use / not fit for use / unknown).
shut_in_type (ShutInTypesEnum | None) – New ShutInTypesEnum (hard / soft / unknown).
rate_multiplier (float | None) – New rate multiplier applied to the reference rate of this shut-in.
comment (str | None) – New comment. Pass an empty string to clear the existing comment.
is_reference (bool | None) – Whether this shut-in should be the reference shut-in.

Return type:

None

get_log_log_preview_from_shut_in_dates(pressure_id=None, to_date=None, tp=10)[source]#

Get Loglog preview DocumentVector from shut-in dates :param pressure_id: Pressure vector id to use :param to_date: End date of the shut-in, if None it will use the initial end date of the shut-in :param tp: Horner Time on production

Returns:

List[:class:`DocumentVector]` – List of document vectors which contains the Loglog dP values and the Bourdet derivative values

Parameters:

pressure_id (str | None)
to_date (datetime | None)
tp (float)

Return type:

List[DocumentVector]