Project Tree Classes

ResInsight provides access to a number of other objects in the Project Tree. These all inherit the PdmObjectBase class class.

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)

rips Package

Classes

Case([pb2_object, channel])

The ResInsight base class for Cases

CellColors([pb2_object, channel])

Eclipse Cell Colors class

CellFilterCollection([pb2_object, channel])

rips.active

CheckableNamedObject([pb2_object, channel])

rips.is_checked

ColorLegend([pb2_object, channel])

CommandRouter([pb2_object, channel])

The CommandRouter is used to call code independent to the project

CurveIntersection([pb2_object, channel])

rips.name

DataContainerFloat([pb2_object, channel])

rips.values

DataContainerString([pb2_object, channel])

rips.values

DataContainerTime([pb2_object, channel])

rips.values

DepthTrackPlot([pb2_object, channel])

rips.auto_scale_depth_enabled

EclipseCase([pb2_object, channel])

The Regular Eclipse Results Case

EclipseContourMap([pb2_object, channel])

A contour map for Eclipse cases

EclipseResult([pb2_object, channel])

An eclipse result definition

EclipseView([pb2_object, channel])

The Eclipse 3d Reservoir View

ElasticProperties([pb2_object, channel])

rips.file_path

ElasticPropertyScaling([pb2_object, channel])

rips.facies

ElasticPropertyScalingCollection([...])

EnsembleStatisticsSurface([pb2_object, channel])

EnsembleSurface([pb2_object, channel])

EnsembleWellLogs([pb2_object, channel])

FaciesInitialPressureConfig([pb2_object, ...])

rips.facies_name

FaciesProperties([pb2_object, channel])

rips.color_legend

FileSummaryCase([pb2_object, channel])

A Summary Case based on SMSPEC files

FileWellPath([pb2_object, channel])

Well Paths Loaded From File

Fracture([pb2_object, channel])

FractureTemplate([pb2_object, channel])

rips.azimuth_angle

FractureTemplateCollection([pb2_object, channel])

GeoMechCase([pb2_object, channel])

The Abaqus Based GeoMech Case

GeoMechContourMap([pb2_object, channel])

A contour map for GeoMech cases

GeoMechPart([pb2_object, channel])

rips.part_id

GeoMechPartCollection([pb2_object, channel])

GeoMechView([pb2_object, channel])

The Geomechanical 3d View

Grid(index, case, channel)

Grid Information.

GridCaseGroup([pb2_object, channel])

A statistics case group

GridCaseSurface([pb2_object, channel])

rips.include_inactive_cells

GridSummaryCase([pb2_object, channel])

A Summary Case based on extracting grid data.

Instance([port, launched])

The ResInsight Instance class.

IntersectionCollection([pb2_object, channel])

MeshFractureTemplate([pb2_object, channel])

rips.active_time_step_index

ModeledWellPath([pb2_object, channel])

A Well Path created interactively in ResInsight

MudWeightWindowParameters([pb2_object, channel])

NamedObject([pb2_object, channel])

rips.name

NonNetLayers([pb2_object, channel])

rips.cutoff

PdmObjectBase(pb2_object, channel)

The ResInsight base class for the Project Data Model

Perforation([pb2_object, channel])

rips.diameter

PerforationCollection([pb2_object, channel])

Plot([pb2_object, channel])

The Abstract Base Class for all Plot Objects

PlotCurve([pb2_object, channel])

PlotWindow([pb2_object, channel])

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

PressureTable([pb2_object, channel])

rips.pressure_date

PressureTableItem([pb2_object, channel])

rips.depth

Project([pb2_object, channel])

The ResInsight Project

ResampleData([pb2_object, channel])

rips.time_steps

Reservoir([pb2_object, channel])

Abstract base class for Eclipse Cases

RimRoffCase([pb2_object, channel])

RimStatisticalCalculation([pb2_object, channel])

rips.calculate_percentiles

RimTextAnnotation([pb2_object, channel])

SimulationWell([pb2_object, channel])

An Eclipse Simulation Well

StimPlanFractureTemplate([pb2_object, channel])

StimPlanModel([pb2_object, channel])

rips.anchor_position

StimPlanModelCollection([pb2_object, channel])

StimPlanModelPlot([pb2_object, channel])

A fracture model plot

StimPlanModelPlotCollection([pb2_object, ...])

StimPlanModelTemplate([pb2_object, channel])

rips.default_facies

StimPlanModelTemplateCollection([...])

SummaryCase([pb2_object, channel])

The Base Class for all Summary Cases

SummaryCaseSubCollection([pb2_object, channel])

rips.create_auto_name

SummaryPlot([pb2_object, channel])

A Summary Plot

SummaryPlotCollection([pb2_object, channel])

Surface([pb2_object, channel])

SurfaceCollection([pb2_object, channel])

rips.surface_user_decription

SurfaceInterface([pb2_object, channel])

rips.depth_offset

ThermalFractureTemplate([pb2_object, channel])

rips.filter_cake_pressure_drop

TriangleGeometry([pb2_object, channel])

rips.connections

View([pb2_object, channel])

rips.background_color

ViewWindow([pb2_object, channel])

The Base Class for all Views and Plots in ResInsight

WbsParameters([pb2_object, channel])

rips.df_source

WellBoreStabilityPlot([pb2_object, channel])

A GeoMechanical Well Bore Stability Plot

WellLogExtractionCurve([pb2_object, channel])

WellLogPlot([pb2_object, channel])

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

WellLogPlotCollection([pb2_object, channel])

WellLogPlotCurve([pb2_object, channel])

WellLogPlotTrack([pb2_object, channel])

WellPath([pb2_object, channel])

A ResInsight Well Path

WellPathCollection([pb2_object, channel])

Collection of Well Paths

WellPathCompletionSettings([pb2_object, channel])

rips.group_name_for_export

WellPathCompletions([pb2_object, channel])

WellPathFracture([pb2_object, channel])

WellPathGeometry([pb2_object, channel])

Class containing the geometry of a modeled Well Path

WellPathTarget([pb2_object, channel])

Class containing the Well Target definition

Class Inheritance Diagram

Inheritance diagram of rips.generated.generated_classes.Case, rips.generated.generated_classes.CellColors, rips.generated.generated_classes.CellFilterCollection, rips.generated.generated_classes.CheckableNamedObject, rips.generated.generated_classes.ColorLegend, rips.generated.generated_classes.CommandRouter, rips.generated.generated_classes.CurveIntersection, rips.generated.generated_classes.DataContainerFloat, rips.generated.generated_classes.DataContainerString, rips.generated.generated_classes.DataContainerTime, rips.generated.generated_classes.DepthTrackPlot, rips.generated.generated_classes.EclipseCase, rips.generated.generated_classes.EclipseContourMap, rips.generated.generated_classes.EclipseResult, rips.generated.generated_classes.EclipseView, rips.generated.generated_classes.ElasticProperties, rips.generated.generated_classes.ElasticPropertyScaling, rips.generated.generated_classes.ElasticPropertyScalingCollection, rips.generated.generated_classes.EnsembleStatisticsSurface, rips.generated.generated_classes.EnsembleSurface, rips.generated.generated_classes.EnsembleWellLogs, rips.generated.generated_classes.FaciesInitialPressureConfig, rips.generated.generated_classes.FaciesProperties, rips.generated.generated_classes.FileSummaryCase, rips.generated.generated_classes.FileWellPath, rips.generated.generated_classes.Fracture, rips.generated.generated_classes.FractureTemplate, rips.generated.generated_classes.FractureTemplateCollection, rips.generated.generated_classes.GeoMechCase, rips.generated.generated_classes.GeoMechContourMap, rips.generated.generated_classes.GeoMechPart, rips.generated.generated_classes.GeoMechPartCollection, rips.generated.generated_classes.GeoMechView, rips.grid.Grid, rips.generated.generated_classes.GridCaseGroup, rips.generated.generated_classes.GridCaseSurface, rips.generated.generated_classes.GridSummaryCase, rips.instance.Instance, rips.generated.generated_classes.IntersectionCollection, rips.generated.generated_classes.MeshFractureTemplate, rips.generated.generated_classes.ModeledWellPath, rips.generated.generated_classes.MudWeightWindowParameters, rips.generated.generated_classes.NamedObject, rips.generated.generated_classes.NonNetLayers, rips.pdmobject.PdmObjectBase, rips.generated.generated_classes.Perforation, rips.generated.generated_classes.PerforationCollection, rips.generated.generated_classes.Plot, rips.generated.generated_classes.PlotCurve, rips.generated.generated_classes.PlotWindow, rips.generated.generated_classes.PressureTable, rips.generated.generated_classes.PressureTableItem, rips.generated.generated_classes.Project, rips.generated.generated_classes.ResampleData, rips.generated.generated_classes.Reservoir, rips.generated.generated_classes.RimRoffCase, rips.generated.generated_classes.RimStatisticalCalculation, rips.generated.generated_classes.RimTextAnnotation, rips.generated.generated_classes.SimulationWell, rips.generated.generated_classes.StimPlanFractureTemplate, rips.generated.generated_classes.StimPlanModel, rips.generated.generated_classes.StimPlanModelCollection, rips.generated.generated_classes.StimPlanModelPlot, rips.generated.generated_classes.StimPlanModelPlotCollection, rips.generated.generated_classes.StimPlanModelTemplate, rips.generated.generated_classes.StimPlanModelTemplateCollection, rips.generated.generated_classes.SummaryCase, rips.generated.generated_classes.SummaryCaseSubCollection, rips.generated.generated_classes.SummaryPlot, rips.generated.generated_classes.SummaryPlotCollection, rips.generated.generated_classes.Surface, rips.generated.generated_classes.SurfaceCollection, rips.generated.generated_classes.SurfaceInterface, rips.generated.generated_classes.ThermalFractureTemplate, rips.generated.generated_classes.TriangleGeometry, rips.generated.generated_classes.View, rips.generated.generated_classes.ViewWindow, rips.generated.generated_classes.WbsParameters, rips.generated.generated_classes.WellBoreStabilityPlot, rips.generated.generated_classes.WellLogExtractionCurve, rips.generated.generated_classes.WellLogPlot, rips.generated.generated_classes.WellLogPlotCollection, rips.generated.generated_classes.WellLogPlotCurve, rips.generated.generated_classes.WellLogPlotTrack, rips.generated.generated_classes.WellPath, rips.generated.generated_classes.WellPathCollection, rips.generated.generated_classes.WellPathCompletionSettings, rips.generated.generated_classes.WellPathCompletions, rips.generated.generated_classes.WellPathFracture, rips.generated.generated_classes.WellPathGeometry, rips.generated.generated_classes.WellPathTarget