ResSimpy.Nexus.DataModels.NexusWell.NexusWell

class ResSimpy.Nexus.DataModels.NexusWell.NexusWell(well_name: 'str', completions: 'Sequence[NexusCompletion]', units: 'UnitSystem')[source]

Bases: Well

Public Data Attributes:

`perforations`	Returns a list of all of the perforations for the well.
`first_perforation`	Returns the first perforation for the well.
`shutins`	Returns a list of all of the shut-ins for the well.
`last_shutin`	Returns the last shut-in for the well in the Wellspec file.
`dates_of_completions`	Returns a list of dates that the well was changed using a completion.
`printable_well_info`	Returns some printable well information in string format.
`completion_events`	Returns a list of dates and values representing either the layer, or the depths of each perforation.

Inherited from Well

`completions`
`well_name`
`units`
`perforations`	Returns a list of all of the perforations for the well.
`first_perforation`	Returns the first perforation for the well.
`shutins`	Returns a list of all of the perforations for the well.
`last_shutin`	Returns the first perforation for the well.
`printable_well_info`	Returns some printable well information in string format.
`completion_events`	Returns a list of dates and values representing either the layer, or the depths of each perforation.

Methods:

`__init__`(well_name, completions, units)
`__repr__`()	Return repr(self).
`find_completions`(completion_properties)	Returns a list of all completions that match the completion properties provided.
`find_completion`(completion_properties)	Returns precisely one completion which matches all the properties provided.
`get_completion_by_id`(id)	Returns the completion that matches the id provided.
`__eq__`(other)	Return self==value.

Inherited from Well

`__init__`(well_name, completions, units)
`__repr__`()	Return repr(self).
`__eq__`(other)	Return self==value.

__init__(well_name: str, completions: Sequence[NexusCompletion], units: UnitSystem) → None[source]

property perforations: Sequence[NexusCompletion]: Returns a list of all of the perforations for the well.

property first_perforation: NexusCompletion | None: Returns the first perforation for the well.

property shutins: Sequence[NexusCompletion]: Returns a list of all of the shut-ins for the well.

property last_shutin: NexusCompletion | None: Returns the last shut-in for the well in the Wellspec file.

property dates_of_completions: list[str]: Returns a list of dates that the well was changed using a completion.

property printable_well_info: str: Returns some printable well information in string format.

property completion_events: list[tuple[str, Union[int, tuple[float, float]]]]: Returns a list of dates and values representing either the layer, or the depths of each perforation.

find_completions(completion_properties: dict[str, None | float | int | str] | NexusCompletion) → list[ResSimpy.Nexus.DataModels.NexusCompletion.NexusCompletion][source]: Returns a list of all completions that match the completion properties provided.

Args:

completion_properties (dict | NexusCompletion): keys as the attributes and values as the value to match from the well.

Returns:

list[NexusCompletion] that match the completion properties provided

find_completion(completion_properties: dict[str, None | float | int | str] | NexusCompletion) → NexusCompletion[source]

Returns precisely one completion which matches all the properties provided.: If several completions match it raise a ValueError.

Args:

completion_properties (dict | NexusCompletion):

Returns:

NexusCompletion that matches all completion properties provided.

get_completion_by_id(id: UUID) → NexusCompletion[source]: Returns the completion that matches the id provided.