Automatically Generated Classes

ResInsight provides access to a number of other objects in the Project Tree. These client code for these is automatically generated with the ResInsight build.

While the documentation refers to for example rips.generated.resinsight_classes.EclipseView the generated.resinsight_classes part is not necessary and the class can simply be referred to as rips.EclipseView.

You can look for objects of a specific type by using the descendants method of rips.project

import rips
# Connect to ResInsight instance
resinsight = rips.Instance.find()
# Example code
print("ResInsight version: " + resinsight.version_string())
# Get a list of all Eclipsev view in the project
views = resinsight.project.descendants(rips.EclipseView)
class rips.generated.resinsight_classes.Case(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

The ResInsight base class for Cases

file_path

Case File Name

Type:str
id

Case ID

Type:int
name

Case Name

Type:str
class rips.generated.resinsight_classes.CellColors(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.EclipseResult

Eclipse Cell Colors class

class rips.generated.resinsight_classes.CheckableNamedObject(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

class rips.generated.resinsight_classes.DataContainerFloat(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

values

Float Values

Type:List of float
class rips.generated.resinsight_classes.DataContainerString(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

values

String Values

Type:List of str
class rips.generated.resinsight_classes.DataContainerTime(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

values

Time Values

Type:List of time
class rips.generated.resinsight_classes.DepthTrackPlot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.PlotWindow

auto_scale_depth_enabled

Auto Scale

Type:str
axis_title_font_size

Axis Title Font Size

Type:str
axis_value_font_size

Axis Value Font Size

Type:str
depth_type

Type

Type:str
depth_unit

Unit

Type:str
maximum_depth

Max

Type:float
minimum_depth

Min

Type:float
show_depth_grid_lines

Show Grid Lines

Type:str
show_title_in_plot

Show Title

Type:str
sub_title_font_size

Track Title Font Size

Type:str
class rips.generated.resinsight_classes.EclipseCase(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.Reservoir

The Regular Eclipse Results Case

class rips.generated.resinsight_classes.EclipseContourMap(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.EclipseView

A contour map for Eclipse cases

class rips.generated.resinsight_classes.EclipseResult(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

An eclipse result definition

flow_tracer_selection_mode

Tracers

Type:str
phase_selection

Phases

Type:str
porosity_model_type

Porosity

Type:str
result_type

Type

Type:str
result_variable

Variable

Type:str
selected_injector_tracers

Injector Tracers

Type:List of str
selected_producer_tracers

Producer Tracers

Type:List of str
selected_souring_tracers

Tracers

Type:List of str
class rips.generated.resinsight_classes.EclipseView(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.View

The Eclipse 3d Reservoir View

cell_result()

Cell Result :returns: CellColors

cell_result_data()

Current Eclipse Cell Result :returns: str

set_cell_result_data(values)

Set Current Eclipse Cell Result :param values: data :type values: str

class rips.generated.resinsight_classes.ElasticProperties(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

file_path

File Path

Type:str
properties_table

Properties Table

Type:str
class rips.generated.resinsight_classes.FaciesProperties(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

color_legend

Colors

Type:str
file_path

File Path

Type:str
properties_table

Properties Table

Type:str
facies_definition()
Returns:EclipseResult
class rips.generated.resinsight_classes.FileSummaryCase(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.SummaryCase

A Summary Case based on SMSPEC files

include_restart_files

Include Restart Files

Type:str
class rips.generated.resinsight_classes.FileWellPath(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.WellPath

Well Paths Loaded From File

class rips.generated.resinsight_classes.FractureModelCollection(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.CheckableNamedObject

fracture_models()
Returns:List of RimFractureModel
new_fracture_model(well_path=None, measured_depth=None, fracture_model_template=None)

Create a new Fracture Model :param well_path: Well Path :type well_path: WellPathBase :param measured_depth: Measured Depth :type measured_depth: float :param fracture_model_template: Fracture Model Template :type fracture_model_template: RimFractureModelTemplate

Returns:RimFractureModel
class rips.generated.resinsight_classes.FractureModelPlot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.DepthTrackPlot

A fracture model plot

fracture_model

Fracture Model

Type:str
export_to_file(directory_path=None)

Export Fracture Model Plot to File :param directory_path: Directory Path :type directory_path: str

Returns:FractureModelPlot
class rips.generated.resinsight_classes.FractureModelPlotCollection(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

fracture_model_plots()
Returns:List of FractureModelPlot
new_fracture_model_plot(eclipse_case=None, fracture_model=None, time_step=None)

Create a new Fracture Model :param eclipse_case: Eclipse Case :type eclipse_case: RimReservoir :param fracture_model: Fracture Model :type fracture_model: RimFractureModel :param time_step: Time Step :type time_step: int

Returns:FractureModelPlot
class rips.generated.resinsight_classes.FractureModelTemplateCollection(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

fracture_model_templates()

Fracture Model Templates :returns: List of RimFractureModelTemplate

new_fracture_model_template(facies_properties_file_path=None, elastic_properties_file_path=None)

Create a new Fracture Model Template :param facies_properties_file_path: Facies Properties File Path :type facies_properties_file_path: str :param elastic_properties_file_path: Elastic Properties File Path :type elastic_properties_file_path: str

Returns:RimFractureModelTemplate
class rips.generated.resinsight_classes.GeoMechCase(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.Case

The Abaqus Based GeoMech Case

views()

All GeoMech Views in the Case :returns: List of GeoMechView

class rips.generated.resinsight_classes.GeoMechContourMap(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.GeoMechView

A contour map for GeoMech cases

class rips.generated.resinsight_classes.GeoMechView(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.View

The Geomechanical 3d View

class rips.generated.resinsight_classes.GridCaseGroup(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

A statistics case group

group_id

Case Group ID

Type:int
user_description

Name

Type:str
class rips.generated.resinsight_classes.GridSummaryCase(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.SummaryCase

A Summary Case based on extracting grid data.

class rips.generated.resinsight_classes.ModeledWellPath(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.WellPath

A Well Path created interactively in ResInsight

well_path_geometry()

Trajectory :returns: WellPathGeometry

class rips.generated.resinsight_classes.MudWeightWindowParameters(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

class rips.generated.resinsight_classes.Plot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.PlotWindow

The Abstract Base Class for all Plot Objects

class rips.generated.resinsight_classes.PlotWindow(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.ViewWindow

The Abstract base class for all MDI Windows in the Plot Window

id

View ID

Type:int
class rips.generated.resinsight_classes.Project(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

The ResInsight Project

import_summary_case(file_name=None)

Import Summary Case :param file_name: :type file_name: str

Returns:FileSummaryCase
summary_case(case_id=None)

Find Summary Case :param case_id: :type case_id: int

Returns:FileSummaryCase
surface_folder(folder_name=None)

Get Surface Folder :param folder_name: :type folder_name: str

Returns:SurfaceCollection
class rips.generated.resinsight_classes.ResampleData(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

time_steps

Time Steps

Type:List of time
values

Values

Type:List of float
class rips.generated.resinsight_classes.Reservoir(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.Case

Abtract base class for Eclipse Cases

views()

All Eclipse Views in the case :returns: List of EclipseView

class rips.generated.resinsight_classes.RimFractureModel(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.CheckableNamedObject

anchor_position

Anchor Position

Type:str
auto_compute_barrier

Auto Compute Barrier

Type:str
azimuth_angle

Azimuth Angle

Type:float
barrier

Barrier

Type:str
barrier_annotation

Barrier Annotation

Type:str
barrier_dip

Barrier Dip

Type:float
barrier_fault_name

Barrier Fault

Type:str
barrier_text_annotation

Barrier Text Annotation

Type:str
bounding_box_horizontal

Bounding Box Horizontal

Type:float
bounding_box_vertical

Bounding Box Vertical

Type:float
distance_to_barrier

Distance To Barrier [m]

Type:float
extraction_type

Extraction Type

Type:str
formation_dip

Formation Dip

Type:float
fracture_orientation

Fracture Orientation

Type:str
md

MD

Type:float
perforation_length

Perforation Length [m]

Type:float
poro_elastic_constant

Poro-Elastic Constant

Type:float
relative_permeability_factor

Relative Permeability Factor

Type:float
show_all_faults

Show All Faults

Type:str
show_only_barrier_fault

Show Only Barrier Fault

Type:str
thermal_expansion_coefficient

Thermal Expansion Coefficient [1/C]

Type:float
thickness_direction

Thickness Direction

Type:str
thickness_direction_well_path

Thickness Direction Well Path

Type:str
use_detailed_fluid_loss

Use Detailed Fluid Loss

Type:str
well_penetration_layer

Well Penetration Layer

Type:int
class rips.generated.resinsight_classes.RimFractureModelTemplate(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

default_permeability

Default Permeability

Type:float
default_porosity

Default Porosity

Type:float
id

ID

Type:int
overburden_facies

Overburden Facies

Type:str
overburden_fluid_density

Overburden Fluid Density [g/cm^3]

Type:float
overburden_formation

Overburden Formation

Type:str
overburden_height

Overburden Height

Type:float
overburden_permeability

Overburden Permeability

Type:float
overburden_porosity

Overburden Porosity

Type:float
reference_temperature

Temperature [C]

Type:float
reference_temperature_depth

Temperature Depth [m]

Type:float
reference_temperature_gradient

Temperature Gradient [C/m]

Type:float
stress_depth

Stress Depth

Type:float
underburden_facies

Underburden Facies

Type:str
underburden_fluid_density

Underburden Fluid Density [g/cm^3]

Type:float
underburden_formation

Underburden Formation

Type:str
underburden_height

Underburden Height

Type:float
underburden_permeability

Underburden Permeability

Type:float
underburden_porosity

Underburden Porosity

Type:float
vertical_stress

Vertical Stress

Type:float
vertical_stress_gradient

Vertical Stress Gradient

Type:float
elastic_properties()

Elastic Properties :returns: ElasticProperties

facies_properties()

Facies Properties :returns: FaciesProperties

class rips.generated.resinsight_classes.SimulationWell(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

An Eclipse Simulation Well

name

Name

Type:str
class rips.generated.resinsight_classes.SummaryCase(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

The Base Class for all Summary Cases

auto_shorty_name

Use Auto Display Name

Type:str
id

Case ID

Type:int
name_setting

Name Setting

Type:str
short_name

Display Name

Type:str
summary_header_filename

Summary Header File

Type:str
available_addresses()

Arguments:

Returns:DataContainerString
available_time_steps()

Arguments:

Returns:DataContainerTime
resample_values(address=None, resampling_period=None)
Parameters:
  • address (str) -- Formatted address specifying the summary vector
  • resampling_period (str) -- Resampling Period
Returns:

ResampleData

summary_vector_values(address=None)

Create a new Summary Plot :param address: Formatted address specifying the summary vector :type address: str

Returns:DataContainerFloat
class rips.generated.resinsight_classes.SummaryCaseSubCollection(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

id

Ensemble ID

Type:int
is_ensemble

Is Ensemble

Type:str
name_count

Name

Type:str
summary_collection_name

Name

Type:str
class rips.generated.resinsight_classes.SummaryPlot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.Plot

A Summary Plot

is_using_auto_name

Auto Title

Type:str
normalize_curve_y_values

Normalize all curves

Type:str
plot_description

Name

Type:str
class rips.generated.resinsight_classes.SummaryPlotCollection(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

new_summary_plot(summary_cases=[], ensemble=None, address=None)

Create a new Summary Plot :param summary_cases: Summary Cases :type summary_cases: List of SummaryCase :param ensemble: Ensemble :type ensemble: SummaryCaseSubCollection :param address: Formatted address string specifying the plot options :type address: str

Returns:SummaryPlot
class rips.generated.resinsight_classes.Surface(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.SurfaceInterface

class rips.generated.resinsight_classes.SurfaceCollection(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

surface_user_decription

Name

Type:str
add_folder(folder_name=None)

Add a new surface folder :param folder_name: New surface folder name :type folder_name: str

Returns:SurfaceCollection
import_surface(file_name=None)

Import a new surface from file :param file_name: Filename to import surface from :type file_name: str

Returns:Surface
sub_collections()

Surfaces :returns: List of SurfaceCollection

surfaces_field()

Surfaces :returns: List of SurfaceInterface

class rips.generated.resinsight_classes.SurfaceInterface(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

depth_offset

Depth Offset

Type:float
surface_user_decription

Name

Type:str
class rips.generated.resinsight_classes.View(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.ViewWindow

background_color

Background

Type:str
current_time_step

Current Time Step

Type:int
disable_lighting

Disable Results Lighting

Type:str
grid_z_scale

Z Scale

Type:float
id

View ID

Type:int
perspective_projection

Perspective Projection

Type:str
show_grid_box

Show Grid Box

Type:str
show_z_scale

Show Z Scale Label

Type:str
class rips.generated.resinsight_classes.ViewWindow(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

The Base Class for all Views and Plots in ResInsight

class rips.generated.resinsight_classes.WbsParameters(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

df_source

Depletion Factor (DF)

Type:str
fg_multiplier

SH Multiplier for FG in Shale

Type:float
fg_shale_source

FG in Shale Calculation

Type:str
k0_fg_source

K0_FG

Type:str
k0_sh_source

K0_SH

Type:str
obg0_source

Initial Overburden Gradient

Type:str
poission_ratio_source

Poisson Ratio

Type:str
pore_pressure_non_reservoir_source

Non-Reservoir Pore Pressure

Type:str
pore_pressure_reservoir_source

Reservoir Pore Pressure

Type:str
ucs_source

Uniaxial Compressive Strength

Type:str
user_df

User Defined DF

Type:float
user_k0_fg

User Defined K0_FG

Type:float
user_k0_sh

User Defined K0_SH

Type:float
user_poisson_ratio

User Defined Poisson Ratio

Type:float
user_pp_non_reservoir

Multiplier of hydrostatic PP

Type:float
user_ucs

User Defined UCS [bar]

Type:float
water_density

Density of Sea Water [g/cm^3]

Type:float
class rips.generated.resinsight_classes.WellBoreStabilityPlot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.WellLogPlot

A GeoMechanical Well Bore Stabilit Plot

parameters()

Well Bore Stability Parameters :returns: WbsParameters

class rips.generated.resinsight_classes.WellLogPlot(pb2_object=None, channel=None)

Bases: rips.generated.resinsight_classes.DepthTrackPlot

A Well Log Plot With a shared Depth Axis and Multiple Tracks

class rips.generated.resinsight_classes.WellPath(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

The Base class for Well Paths

name

Name

Type:str
class rips.generated.resinsight_classes.WellPathGeometry(pb2_object=None, channel=None)

Bases: rips.pdmobject.PdmObjectBase

Class containing the geometry of a modeled Well Path

air_gap

Air Gap

Type:float
md_at_first_target

MD at First Target

Type:float
reference_point

UTM Reference Point

Type:str
use_auto_generated_target_at_sea_level

Generate Target at Sea Level

Type:str
auto_generated_target()

Auto Generated Target :returns: WellPathTarget

well_path_targets()

Well Targets :returns: List of WellPathTarget

generated.resinsight_classes = <module 'rips.generated.resinsight_classes' from '/home/docs/checkouts/readthedocs.org/user_builds/python-rips-doc/checkouts/stable/docs/rips/generated/resinsight_classes.py'>