kappa_sdk.ShutIn#

class kappa_sdk.ShutIn(start_date, end_date, is_reference, pressure_id, fit_for_use, shut_in_type, kw_api)[source]#

Class to store any shutin

Attributes

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

Parameters:

start_date (datetime)
end_date (datetime)
is_reference (bool)
pressure_id (str | None)
fit_for_use (str)
shut_in_type (str)
kw_api (KWAPI)

__init__(start_date, end_date, is_reference, pressure_id, fit_for_use, shut_in_type, kw_api)[source]#

Parameters:

start_date (datetime)
end_date (datetime)
is_reference (bool)
pressure_id (str | None)
fit_for_use (str)
shut_in_type (str)
kw_api (KWAPI)

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

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]