WellPath

class rips.WellPath(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

A ResInsight Well Path

name

Name

Type:: str

well_path_color

Well Path Color

Type:: str

Methods Summary

`add_fracture`([measured_depth, ...])	Add StimPlan Fracture
`add_icv_valve`([measured_depth])	Add ICV Valve
`add_thermal_fracture`([measured_depth, ...])	Add Thermal Fracture
`add_well_log`(name, measured_depth, channel_data)	Add imported well log data to well path.
`append_fishbones`([sub_locations, drilling_type])	Append Fishbones
`append_lateral_from_geometry`([well_path_lateral])
`append_perforation_interval`([start_md, ...])	Append Perforation Interval
`completion_data`(case_id)	Get well completion data
`completion_settings`()	Completion Settings
`completions`()	Completions
`enable_outlet_valve`([enable, icv_template, ...])	Enable Outlet Valve
`msw_settings`()	Multi Segment Well Settings
`parent_branch`()	Parent Branch
`tie_in`()	Well Path Tie-In Settings
`trajectory_properties`(resampling_interval)	Extracts properties from a well path trajectory.
`well_logs`()	Well Logs

Methods Documentation

add_fracture(measured_depth: float = 0.0, stim_plan_fracture_template: StimPlanFractureTemplate | None = None, align_dip: bool = False, eclipse_case: Reservoir | None = None) → WellPathFracture

Add StimPlan Fracture

Parameters:

measured_depth (float)
stim_plan_fracture_template (Optional[StimPlanFractureTemplate]) -- StimPlan Fracture Template
align_dip (bool)
eclipse_case (Optional[Reservoir]) -- Eclipse Case

Returns:

WellPathFracture

add_icv_valve(measured_depth: float = 0.0) → WellPathValve

Add ICV Valve

Parameters:: measured_depth (float)
Returns:: WellPathValve

add_thermal_fracture(measured_depth: float = 0.0, fracture_template: ThermalFractureTemplate | None = None, place_using_template_data: bool = True) → WellPathFracture

Add Thermal Fracture

Parameters:

measured_depth (float)
fracture_template (Optional[ThermalFractureTemplate]) -- Thermal Fracture Template
place_using_template_data (bool)

Returns:

WellPathFracture

add_well_log(name: str, measured_depth: List[float], channel_data: Dict[str, List[float]], tvd_msl: List[float] | None = None, tvd_rkb: List[float] | None = None) → object

Add imported well log data to well path.

Parameters:

name (str) -- Name of the well log.
measured_depth (List[float]) -- Array of measured depth values.
channel_data (Dict[str, List[float]]) -- Dictionary mapping channel names to their values.
tvd_msl (List[float], optional) -- Array of TVD MSL values. Must match measured_depth length if provided.
tvd_rkb (List[float], optional) -- Array of TVD RKB values. Must match measured_depth length if provided.

Returns:

The created well log object.

append_fishbones(sub_locations: List[float] = [], drilling_type: DrillingType = DrillingType.STANDARD) → Fishbones | None

Append Fishbones

Parameters:

sub_locations (List[float])
drilling_type (DrillingType) -- One of [STANDARD, EXTENDED, ACID_JETTING]

Returns:

FishbonesMultipleSubs

append_lateral_from_geometry(well_path_lateral: WellPath | None = None) → None

Parameters:: well_path_lateral (Optional[WellPath]) -- Well Path Lateral

Returns:

append_perforation_interval(start_md: float = 0.0, end_md: float = 0.0, diameter: float = 0.0, skin_factor: float = 0.0) → Perforation

Append Perforation Interval

Parameters:

start_md (float) -- Start Measured Depth
end_md (float) -- End Measured Depth
diameter (float) -- Diameter
skin_factor (float) -- Skin Factor

Returns:

Perforation

completion_data(case_id: int) → SimulatorTableData

Get well completion data

Returns a SimulatorTableData object containing completion information for this well path.

SimulatorTableRequest description:

Parameter   | Description                                                   | Type
----------- | ------------------------------------------------------------- | -----
well_name   | Well name as string                                           | string
case_id     | ID of the case to use when extracting completion data         | int

completion_settings() → WellPathCompletionSettings | None

Completion Settings

Returns:: WellPathCompletionSettings

completions() → WellPathCompletions | None

Completions

Returns:: WellPathCompletions

enable_outlet_valve(enable: bool = False, icv_template: ValveTemplate | None = None, use_custom_valve_md: bool = False, custom_valve_md: float = 0.0) → WellPathValve | None

Enable Outlet Valve

Parameters:

enable (bool)
icv_template (Optional[ValveTemplate])
use_custom_valve_md (bool)
custom_valve_md (float)

Returns:

WellPathValve

msw_settings() → MswSettings | None

Multi Segment Well Settings

Arguments:

Returns:: RimMswCompletionParameters

parent_branch() → WellPath | None

Parent Branch

Arguments:

Returns:: WellPathBase

tie_in() → WellPathTimeIn | None

Well Path Tie-In Settings

Arguments:

Returns:: RimWellPathTieIn

trajectory_properties(resampling_interval: float) → Dict[str, List[float]]

Extracts properties from a well path trajectory.

Parameters:: resampling_interval (float) -- Interval in measured depth.
Returns:: Dict of properties.

well_logs() → List[WellLog]

Well Logs

Returns:: List[WellLog]