WellPathCollection

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

Bases: PdmObjectBase

Collection of Well Paths

Methods Summary

completion_data_unified([wells, case_id])	Get unified completion data for multiple wells.
event_timeline()	Event Timeline
import_well_path([file_name])
import_well_path_from_points(name, coordinates)	Create a well path from a list of XYZ coordinates.
set_msw_name_grouping([msw_name_grouping])
well_paths()	Well Paths

Methods Documentation

completion_data_unified(wells: List[WellPath] | List[str] | None = None, case_id: int | None = None) → SimulatorTableData

Get unified completion data for multiple wells.

This method merges completion data (COMPDAT, WELSPECS, WELSEGS, COMPSEGS, WSEGVALV, WSEGAICD) from multiple wells into a single response.

Parameters:

• wells -- List of WellPath objects or well names. If None, uses all wells in collection.

• case_id -- ID of the case to use. If None, tries to determine from context.

Returns:

SimulatorTableData containing merged completion data from all specified wells

Raises:

• ValueError -- If case_id cannot be determined or wells list is invalid

• RuntimeError -- If unable to access required data

event_timeline() → WellEventTimeline | None

Event Timeline

Returns:

WellEventTimeline

import_well_path(file_name: str = '') → WellPath

Parameters:

file_name (str)

Returns:

WellPathBase

import_well_path_from_points(name: str, coordinates: List[List[float]]) → object

Create a well path from a list of XYZ coordinates.

Parameters:

• name (str) -- Name of the well path

• coordinates (List[List[float]]) -- List of [x, y, z] coordinate triplets

Returns:

The created well path object

Return type:

RimPointBasedWellPath

Raises:

ValueError -- If coordinates are invalid or have wrong dimensions

set_msw_name_grouping(msw_name_grouping: str = '') → None

Parameters:

msw_name_grouping (str)

Returns:

well_paths() → List[FileWellPath]

Well Paths

Returns:

List[FileWellPath]