Case

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

Bases: PdmObjectBase

The ResInsight base class for Cases

file_path

Case File Name

Type:

Optional[str]

id

Case ID

Type:

int

name

Case Name

Type:

str

name_setting

One of [FULL_CASE_NAME, SHORT_CASE_NAME, CUSTOM_NAME]

Type:

NameSetting

Methods Summary

active_cell_centers([porosity_model])

Get a cell centers for all active cells.

active_cell_centers_async([porosity_model])

Get a cell centers for all active cells.

active_cell_corners([porosity_model])

Get a cell corners for all active cells.

active_cell_corners_async([porosity_model])

Get a cell corners for all active cells.

active_cell_property(property_type, ...[, ...])

Get a cell property for all active cells.

active_cell_property_async(property_type, ...)

Get a cell property for all active cells.

available_nnc_properties()

Get a list of available NNC properties

available_properties(property_type[, ...])

Get a list of available properties

cell_count([porosity_model])

Get a cell count object containing number of active cells and total number of cells

cell_info_for_active_cells([porosity_model])

Get list of cell info objects for current case

cell_info_for_active_cells_async([...])

Get Stream of cell info objects for current case

coarsening_info()

Get a coarsening information for all grids in the case.

create_lgr_for_completion(time_step, ...)

Create a local grid refinement for the completions on the given well paths

create_view()

Create a new 3D view in the case

days_since_start()

Get a list of decimal values representing days since the start of the simulation

discrete_property_category_colors(property_name)

Return the integer-value to color mapping for a discrete property.

discrete_property_category_names(property_name)

Return the integer-value to label mapping for a discrete property.

distance_to_closest_fault(x, y, z)

Find the closest fault to the given point and return the distance, fault name and fault face

export_msw(well_path)

Export Eclipse Multi-segment-well model to file

export_snapshots_of_all_views([prefix, ...])

Export snapshots for all views in the case

export_well_path_completions(time_step, ...)

Export well path completions for the current case to file

grid([index])

Get Grid of a given index

grid_property(property_type, property_name, ...)

Get a cell property for all grid cells.

grid_property_async(property_type, ...[, ...])

Get a cell property for all grid cells.

grids()

Get a list of all rips Grid objects in the case

import_formation_names([formation_files])

Import formation names into project and apply it to the current case

nnc_connections()

Get the NNC connection.

nnc_connections_async()

Get the NNC connections.

nnc_connections_dynamic_values(...)

Get the dynamic NNC values.

nnc_connections_dynamic_values_async(...)

Get the dynamic NNC values.

nnc_connections_generated_values(...)

Get the generated NNC values.

nnc_connections_generated_values_async(...)

Get the generated NNC values.

nnc_connections_static_values(property_name)

Get the static NNC values.

nnc_connections_static_values_async(...)

Get the static NNC values.

replace(new_grid_file)

Replace the current case grid with a new grid loaded from file

replace_corner_point_grid(nx, ny, nz, coord, ...)

Replace the current case grid with new corner point grid geometry

replace_grid([new_grid_file, project_file])

Replace the grid file of the case and reload the project

reservoir_boundingbox()

Get the reservoir bounding box

reservoir_depth_range()

Get the reservoir depth range

selected_cell_property(property_type, ...[, ...])

Get a cell property for all selected cells.

selected_cell_property_async(property_type, ...)

Get a cell property for all selected cells.

selected_cells()

Get the selected cells.

selected_cells_async()

Get the selected cells.

set_active_cell_property(values, ...[, ...])

Set a cell property for all active cells.

set_active_cell_property_async(...[, ...])

Set cell property for all active cells Async.

set_discrete_property_category_names(...[, ...])

Bind integer values of a discrete grid property to text labels.

set_formation_names([formation_names])

Set the active formation names of the case

set_grid_property(values, property_type, ...)

Set a cell property for all grid cells.

set_nnc_connections_values(values, ...[, ...])

Set nnc connection values for all connections..

simulation_wells()

Get a list of all simulation wells for a case

time_steps()

Get a list containing all time steps

view(view_id)

Get a particular view belonging to a case by providing view id

views()

Get all views of a case

Methods Documentation

active_cell_centers(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[Vec3d]

Get a cell centers for all active cells. Synchronous, so returns a list.

Parameters:

porosity_model (str) -- string enum. See available()

Returns:

A list of Vec3d

active_cell_centers_async(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[CellCenters]

Get a cell centers for all active cells. Async, so returns an iterator

Parameters:

porosity_model (str) -- string enum. See available()

Returns:

An iterator to a chunk object containing an array of Vec3d values. Loop through the chunks and then the values within the chunk to get all values.

active_cell_corners(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[CellCorners]

Get a cell corners for all active cells. Synchronous, so returns a list.

Arguments:

porosity_model(str): string enum. See available()

CellCorner class description:

Parameter   | Description   | Type
----------- | ------------  | -----
c0          |               | Vec3d
c1          |               | Vec3d
c2          |               | Vec3d
c3          |               | Vec3d
c4          |               | Vec3d
c5          |               | Vec3d
c6          |               | Vec3d
c7          |               | Vec3d
active_cell_corners_async(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[CellCornersArray]

Get a cell corners for all active cells. Async, so returns an iterator

Parameters:

porosity_model (str) -- string enum. See available()

Returns:

An iterator to a chunk object containing an array of CellCorners (which is eight Vec3d values). Loop through the chunks and then the values within the chunk to get all values.

active_cell_property(property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[float]

Get a cell property for all active cells. Sync, so returns a list. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

Returns:

A list containing double values Loop through the chunks and then the values within the chunk to get all values.

active_cell_property_async(property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[PropertyChunk]

Get a cell property for all active cells. Async, so returns an iterator. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

Returns:

An iterator to a chunk object containing an array of double values Loop through the chunks and then the values within the chunk to get all values.

available_nnc_properties() → List[AvailableNNCProperty]

Get a list of available NNC properties

NNCConnection class description:

Parameter               | Description                                   | Type
------------------------| --------------------------------------------- | -----
cell_grid_index1        | Reservoir Cell Index to cell 1                | int32
cell_grid_index2        | Reservoir Cell Index to cell 2                | int32
cell1                   | Reservoir Cell IJK to cell 1                  | Vec3i
cell2                   | Reservoir Cell IJK to cell 1                  | Vec3i
available_properties(property_type: PropertyType, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[str]

Get a list of available properties

For argument details, see Result Definition

Parameters:
  • property_type (str) -- string corresponding to property_type enum.

  • porosity_model (str) -- 'MATRIX_MODEL' or 'FRACTURE_MODEL'.

cell_count(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → CellCount

Get a cell count object containing number of active cells and total number of cells

Parameters:

porosity_model (str) -- String representing an enum. must be 'MATRIX_MODEL' or 'FRACTURE_MODEL'.

Returns:

active_cell_count: number of active cells reservoir_cell_count: total number of reservoir cells

Return type:

Cell Count object with the following integer attributes

CellCount class description:

Parameter               | Description               | Type
----------------------- | ------------------------- | -----
active_cell_count       | Number of active cells    | Integer
reservoir_cell_count    | Total number of cells     | Integer
cell_info_for_active_cells(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[CellInfo]

Get list of cell info objects for current case

Parameters:

porosity_model (str) -- String representing an enum. must be 'MATRIX_MODEL' or 'FRACTURE_MODEL'.

Returns:

List of CellInfo objects

CellInfo class description:

Parameter                 | Description                                   | Type
------------------------- | --------------------------------------------- | -----
grid_index                | Index to grid                                 | Integer
parent_grid_index         | Index to parent grid                          | Integer
coarsening_box_index      | Index to coarsening box                       | Integer
local_ijk                 | Cell index in IJK directions of local grid    | Vec3i
parent_ijk                | Cell index in IJK directions of parent grid   | Vec3i

Vec3i class description:

Parameter        | Description                                  | Type
---------------- | -------------------------------------------- | -----
i                | I grid index                                 | Integer
j                | J grid index                                 | Integer
k                | K grid index                                 | Integer
cell_info_for_active_cells_async(porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[CellInfoArray]

Get Stream of cell info objects for current case

Parameters:

porosity_model (str) -- String representing an enum. must be 'MATRIX_MODEL' or 'FRACTURE_MODEL'.

Returns:

Stream of CellInfo objects

See rips.case.cell_info_for_active_cells() for detalis on the CellInfo class.

coarsening_info() → List[CoarseningInfo]

Get a coarsening information for all grids in the case.

Returns:

A list of CoarseningInfo objects with two Vec3i min and max objects for each entry.

create_lgr_for_completion(time_step: int, well_path_names: str | List[str], refinement_i: int, refinement_j: int, refinement_k: int, split_type: str) → Any

Create a local grid refinement for the completions on the given well paths

Parameters:

Parameter       | Description                            | Type
--------------- | -------------------------------------- | -----
time_steps      | Time step index                        | Integer
well_path_names | List of well path names                | List of Strings
refinement_i    | Refinement in x-direction              | Integer
refinement_j    | Refinement in y-direction              | Integer
refinement_k    | Refinement in z-direction              | Integer
split_type      | Defines how to split LGRS              | String enum

Enum split_type:

Option                  | Description
------------------------| ------------
"LGR_PER_CELL"          | One LGR for each completed cell
"LGR_PER_COMPLETION"    | One LGR for each completion (fracture, perforation, ...)
"LGR_PER_WELL"          | One LGR for each well

Deprecated: use Reservoir.create_lgr_for_completions(well_paths=[...], ...) instead, which takes WellPath objects.

create_view() → View

Create a new 3D view in the case

Arguments:

Returns:

View

days_since_start() → List[float]

Get a list of decimal values representing days since the start of the simulation

discrete_property_category_colors(property_name: str) → Dict[int, str]

Return the integer-value to color mapping for a discrete property.

Inverse of the value_colors argument to set_discrete_property_category_names. Colors are returned as hex strings (e.g. "#ff8800") in the same form accepted by the setter. Returns an empty dict when no mapping is registered.

Parameters:

property_name (str) -- Name of the discrete property result.

Returns:

Dict mapping each integer category value to its hex color.

discrete_property_category_names(property_name: str) → Dict[int, str]

Return the integer-value to label mapping for a discrete property.

Inverse of set_discrete_property_category_names. Returns an empty dict when no mapping is registered for this property.

Parameters:

property_name (str) -- Name of the discrete property result.

Returns:

Dict mapping each integer category value to its label string.

distance_to_closest_fault(x: float, y: float, z: float) → Tuple[str, float, str]

Find the closest fault to the given point and return the distance, fault name and fault face

export_msw(well_path: str) → Any

Export Eclipse Multi-segment-well model to file

Deprecated: use Reservoir.export_msw_completions(well_paths=[...], export_folder=...) instead, which takes WellPath objects and an explicit export folder.

Parameters:

well_path (str) -- Well path name

export_snapshots_of_all_views(prefix: str = '', export_folder: str = '') → None

Export snapshots for all views in the case

Deprecated: loop over views() and call View.export_snapshot() instead.

Parameters:
  • prefix (str) -- Exported file name prefix

  • export_folder (str) -- The path to export to. By default will use the 'snapshots' folder next to the project file.

export_well_path_completions(time_step: int, well_path_names: str | List[str], file_split: str, compdat_export: str = 'TRANSMISSIBILITIES', include_perforations: bool = True, include_fishbones: bool = True, fishbones_exclude_main_bore: bool = True, export_welspec: bool = True, export_comments: bool = True, custom_file_name: str = '') → Any

Export well path completions for the current case to file

Parameters:

Parameter                   | Description                                      | Type
----------------------------| ------------------------------------------------ | -----
time_step                   | Time step to export for                          | Integer
well_path_names             | List of well path names                          | List
file_split                  | Controls how export data is split into files     | String enum
compdat_export              | Compdat export type                              | String enum
include_perforations        | Export perforations?                             | bool
include_fishbones           | Export fishbones?                                | bool
fishbones_exclude_main_bore | Exclude main bore when exporting fishbones?      | bool
export_welspec              | Export WELSPEC keyword                           | bool
export_comments             | Export completion data source as comment         | bool
custom_file_name            | Custom filename when file_split is "UNIFIED_FILE"| String

Enum file_split:

Option                              | Description
----------------------------------- | ------------
"UNIFIED_FILE"                      | A single file with all combined transmissibilities
"SPLIT_ON_WELL"                     | One file for each well with combined transmissibilities

Enum compdat_export:

Option                                      | Description
------------------------------------------- | ------------
"TRANSMISSIBILITIES"                        | Direct export of transmissibilities
"WPIMULT_AND_DEFAULT_CONNECTION_FACTORS"    | Include WPIMULT in addition to transmissibilities

Deprecated: use Reservoir.export_completions(well_paths=[...], export_folder=...) instead, which takes WellPath objects and an explicit export folder.

grid(index: int = 0) → Grid

Get Grid of a given index

Parameters:

index (int) -- The grid index

Returns:

rips.grid.Grid

grid_property(property_type: PropertyType, property_name: str, time_step: int, grid_index: int = 0, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[float]

Get a cell property for all grid cells. Synchronous, so returns a list. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • grid_index (int) -- index to the grid we're getting values for

  • porosity_model (str) -- string enum

Returns:

A list of double values

grid_property_async(property_type: PropertyType, property_name: str, time_step: int, grid_index: int = 0, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[PropertyChunk]

Get a cell property for all grid cells. Async, so returns an iterator. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • gridIndex (int) -- index to the grid we're getting values for

  • porosity_model (str) -- string enum

Returns:

An iterator to a chunk object containing an array of double values Loop through the chunks and then the values within the chunk to get all values.

grids() → List[Grid]

Get a list of all rips Grid objects in the case

Returns:

List of rips.grid.Grid

import_formation_names(formation_files: str | List[str] | None = None) → None

Import formation names into project and apply it to the current case

Deprecated: use Project.import_formation_names(apply_to_all_cases=False) followed by Case.set_formation_names() instead.

Parameters:

formation_files (list) -- list of files to import

nnc_connections() → List[NNCConnection]

Get the NNC connection. Synchronous, so returns a list.

Returns:

A list of NNCConnection objects.

nnc_connections_async() → Iterator[NNCConnections]

Get the NNC connections. Async, so returns an iterator.

Returns:

An iterator to a chunk object containing an array NNCConnection objects. Loop through the chunks and then the connection within the chunk to get all connections.

nnc_connections_dynamic_values(property_name: str, time_step: int) → List[float]

Get the dynamic NNC values.

Returns:

A list of doubles. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

nnc_connections_dynamic_values_async(property_name: str, time_step: int) → Iterator[NNCValues]

Get the dynamic NNC values. Async, so returns an iterator.

Returns:

An iterator to a chunk object containing an list of doubles. Loop through the chunks and then the values within the chunk to get values for all the connections. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

nnc_connections_generated_values(property_name: str, time_step: int) → List[float]

Get the generated NNC values.

Returns:

A list of doubles. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

nnc_connections_generated_values_async(property_name: str, time_step: int) → Iterator[NNCValues]

Get the generated NNC values. Async, so returns an iterator.

Returns:

An iterator to a chunk object containing an list of doubles. Loop through the chunks and then the values within the chunk to get values for all the connections. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

nnc_connections_static_values(property_name: str) → List[float]

Get the static NNC values.

Returns:

A list of doubles. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

nnc_connections_static_values_async(property_name: str) → Iterator[NNCValues]

Get the static NNC values. Async, so returns an iterator.

Returns:

An iterator to a chunk object containing an list of doubles. Loop through the chunks and then the values within the chunk to get values for all the connections. The order of the list matches the list from nnc_connections, i.e. the nth object of nnc_connections() refers to nth value in this list.

replace(new_grid_file: str) → None

Replace the current case grid with a new grid loaded from file

Deprecated: use replace_grid(new_grid_file) instead.

Parameters:

new_grid_file (str) -- Path to EGRID file

replace_corner_point_grid(nx: int, ny: int, nz: int, coord: List[float], zcorn: List[float], actnum: List[int])

Replace the current case grid with new corner point grid geometry

This method modifies the geometry of an existing case by replacing it with new grid parameters. All existing properties will be cleared.

Parameters:
  • nx (int) -- Number of cells in x direction

  • ny (int) -- Number of cells in y direction

  • nz (int) -- Number of cells in z direction

  • coord (list[float]) -- Coordinate lines as COORD keyword in Eclipse. Each coordinate line is defined by two points (top and bottom). Size: (nx+1) * (ny+1) * 2 * 3. Points are ordered as in Eclipse.

  • zcorn (list[float]) -- Corner depths as defined by the Eclipse keyword ZCORN. Size: nx * ny * nz * 8

  • actnum (list[int]) -- Active cell info: cells with values > 0 are active. Size: nx * ny * nz

replace_grid(new_grid_file: str = '', project_file: str = '') → None

Replace the grid file of the case and reload the project

Parameters:
  • new_grid_file (str) -- Path to the new grid file (EGRID, GRID, GRDECL or ODB)

  • project_file (str) -- Optional project file to reload. Defaults to the current project file.

Returns:

reservoir_boundingbox() → BoundingBox

Get the reservoir bounding box

Returns:

BoundingBox

BoundingBox class description:

Type      | Name
--------- | ----------
int       | min_x
int       | max_x
int       | min_y
int       | max_y
int       | min_z
int       | max_z
reservoir_depth_range() → Tuple[float, float]

Get the reservoir depth range

Returns:

A tuple with two members. The first is the minimum depth, the second is the maximum depth

selected_cell_property(property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → List[float]

Get a cell property for all selected cells. Sync, so returns a list. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

Returns:

A list containing double values Loop through the chunks and then the values within the chunk to get all values.

selected_cell_property_async(property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → Iterator[PropertyChunk]

Get a cell property for all selected cells. Async, so returns an iterator. For argument details, see Result Definition

Parameters:
  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

Returns:

An iterator to a chunk object containing an array of double values Loop through the chunks and then the values within the chunk to get all values.

selected_cells() → List[SelectedCell]

Get the selected cells. Synchronous, so returns a list.

Returns:

A list of Cells.

selected_cells_async() → Iterator[SelectedCells]

Get the selected cells. Async, so returns an iterator.

Returns:

An iterator to a chunk object containing an array of cells. Loop through the chunks and then the cells within the chunk to get all cells.

set_active_cell_property(values: List[float], property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL, data_type: PropertyDataType = PropertyDataType.FLOAT) → None

Set a cell property for all active cells. For argument details, see Result Definition

Parameters:
  • values (list) -- a list of double precision floating point numbers

  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

  • data_type (str) -- property data type ("FLOAT" or "INTEGER"). Use "INTEGER" to create a discrete/category property.

set_active_cell_property_async(values_iterator: Iterable[List[float]], property_type: PropertyType, property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL, data_type: PropertyDataType = PropertyDataType.FLOAT) → None

Set cell property for all active cells Async. Takes an iterator to the input values. For argument details, see Result Definition

Parameters:
  • values_iterator (iterator) -- an iterator to the properties to be set

  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum

  • data_type (str) -- property data type ("FLOAT" or "INTEGER"). Use "INTEGER" to create a discrete/category property.

set_discrete_property_category_names(property_name: str, value_names: Dict[int, str], value_colors: Dict[int, str] | None = None, legend_name: str | None = None) → ColorLegend | None

Bind integer values of a discrete grid property to text labels.

Use this after uploading a discrete property via set_grid_property(..., data_type="INTEGER") or set_active_cell_property(..., data_type="INTEGER") to display text labels instead of raw integers in the 3D view legend.

Repeated calls for the same property update the existing color legend in place, so views referencing the legend keep their binding.

Parameters:
  • property_name (str) -- Name of the discrete property result.

  • value_names (Dict[int, str]) -- Mapping from integer value to label. An empty dict removes any existing mapping for this property.

  • value_colors (Optional[Dict[int, str]]) -- Optional per-value colors as strings accepted by QColor (e.g. "red", "#ff8800"). Values without a color entry get an auto-assigned palette color.

  • legend_name (Optional[str]) -- Optional name for the color legend. Defaults to the property name.

Returns:

The created or updated ColorLegend, or None if value_names was empty.

set_formation_names(formation_names: FormationNames | None = None) → None

Set the active formation names of the case

Parameters:

formation_names (Optional[FormationNames]) -- Formation names object, e.g. from Project.import_formation_names()

Returns:

set_grid_property(values: List[float], property_type: PropertyType, property_name: str, time_step: int, grid_index: int = 0, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL, data_type: PropertyDataType = PropertyDataType.FLOAT) → None

Set a cell property for all grid cells. For argument details, see Result Definition

Parameters:
  • values (list) -- a list of double precision floating point numbers

  • property_type (str) -- string enum

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • grid_index (int) -- index to the grid we're setting values for

  • porosity_model (str) -- string enum

  • data_type (str) -- property data type ("FLOAT" or "INTEGER"). Use "INTEGER" to create a discrete/category property.

set_nnc_connections_values(values: List[float], property_name: str, time_step: int, porosity_model: PorosityModelType = PorosityModelType.MATRIX_MODEL) → None

Set nnc connection values for all connections..

Parameters:
  • values (list) -- a list of double precision floating point numbers

  • property_name (str) -- name of an Eclipse property

  • time_step (int) -- the time step for which to get the property for

  • porosity_model (str) -- string enum. See available()

simulation_wells() → List[SimulationWell]

Get a list of all simulation wells for a case

Returns:

rips.generated.generated_classes.SimulationWell

time_steps() → List[TimeStepDate]

Get a list containing all time steps

The time steps are defined by the class TimeStepDate

TimeStepDate class description:

Type      | Name
--------- | ----------
int       | year
int       | month
int       | day
int       | hour
int       | minute
int       | second
view(view_id: int) → View | None

Get a particular view belonging to a case by providing view id

Parameters:

view_id (int) -- view id

Returns:

rips.generated.generated_classes.View

views() → List[View]

Get all views of a case

Returns:

List of rips.generated.generated_classes.View