Updated python API for 2024.03

Author: magnesj

docs/rips/contour_map.py

@@ -1,6 +1,7 @@
 """
 ResInsight 3d contour map module
 """
+
 import Commands_pb2
 
 from .pdmobject import add_method

docs/rips/generated/PdmObject_pb2.py

@@ -55,6 +55,11 @@ def __init__(self, channel):
                 request_serializer=PdmObject__pb2.PdmObjectMethodRequest.SerializeToString,
                 response_deserializer=PdmObject__pb2.PdmObject.FromString,
                 )
+        self.DeleteExistingPdmObject = channel.unary_unary(
+                '/rips.PdmObjectService/DeleteExistingPdmObject',
+                request_serializer=PdmObject__pb2.PdmObject.SerializeToString,
+                response_deserializer=Definitions__pb2.Empty.FromString,
+                )
 
 
 class PdmObjectServiceServicer(object):
@@ -108,6 +113,12 @@ def CallPdmObjectMethod(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def DeleteExistingPdmObject(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_PdmObjectServiceServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -151,6 +162,11 @@ def add_PdmObjectServiceServicer_to_server(servicer, server):
                     request_deserializer=PdmObject__pb2.PdmObjectMethodRequest.FromString,
                     response_serializer=PdmObject__pb2.PdmObject.SerializeToString,
             ),
+            'DeleteExistingPdmObject': grpc.unary_unary_rpc_method_handler(
+                    servicer.DeleteExistingPdmObject,
+                    request_deserializer=PdmObject__pb2.PdmObject.FromString,
+                    response_serializer=Definitions__pb2.Empty.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'rips.PdmObjectService', rpc_method_handlers)
@@ -296,3 +312,20 @@ def CallPdmObjectMethod(request,
             PdmObject__pb2.PdmObject.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def DeleteExistingPdmObject(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/rips.PdmObjectService/DeleteExistingPdmObject',
+            PdmObject__pb2.PdmObject.SerializeToString,
+            Definitions__pb2.Empty.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

docs/rips/generated/PdmObject_pb2_grpc.py

@@ -16,8 +16,8 @@
 #  Python version of RiaVersionInfo.h
 #  Just sets version constants
 
-RESINSIGHT_MAJOR_VERSION : str = "2023"
-RESINSIGHT_MINOR_VERSION : str = "12"
+RESINSIGHT_MAJOR_VERSION : str = "2024"
+RESINSIGHT_MINOR_VERSION : str = "03"
 RESINSIGHT_PATCH_VERSION : str = "0"
 
 PYTHON_GRPC_PROTOC_VERSION : str = "libprotoc 23.4"

docs/rips/generated/RiaVersionInfo.py

@@ -31,7 +31,7 @@ class CurveIntersection(PdmObjectBase):
         name (str): Name
         points (List[List[float]]): Points
         simulation_well (Optional[SimulationWell]): Simulation Well
-        type (str): One of [CS_WELL_PATH, CS_SIMULATION_WELL, CS_POLYLINE, CS_AZIMUTHLINE]
+        type (str): One of [CS_WELL_PATH, CS_SIMULATION_WELL, CS_POLYLINE, CS_AZIMUTHLINE, CS_POLYGON]
         well_path (Optional[WellPath]): Well Path        
     """
     __custom_init__ = None #: Assign a custom init routine to be run at __init__
@@ -461,7 +461,7 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         self.id: int = -1
         self.name_setting: str = "FULL_CASE_NAME"
         self.short_name: str = ""
-        self.show_sub_nodes_in_tree: bool = False
+        self.show_sub_nodes_in_tree: bool = True
         self.summary_header_filename: Optional[str] = None
         PdmObjectBase.__init__(self, pb2_object, channel)
         if SummaryCase.__custom_init__ is not None:
@@ -1133,6 +1133,14 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if EclipseContourMap.__custom_init__ is not None:
             EclipseContourMap.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class RimEmCase(Reservoir):
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        Reservoir.__init__(self, pb2_object, channel)
+        if RimEmCase.__custom_init__ is not None:
+            RimEmCase.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class GeoMechContourMap(GeoMechView):
     """
     A contour map for GeoMech cases
@@ -2308,6 +2316,7 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['Project'] = Project
     classes['ResampleData'] = ResampleData
     classes['Reservoir'] = Reservoir
+    classes['RimEmCase'] = RimEmCase
     classes['RimRoffCase'] = RimRoffCase
     classes['RimStatisticalCalculation'] = RimStatisticalCalculation
     classes['RimTextAnnotation'] = RimTextAnnotation

docs/rips/generated/generated_classes.py

@@ -285,9 +285,9 @@ def _check_connection_and_version(
             raise Exception(
                 "Error: Wrong Version of ResInsight at ",
                 location,
-                self.version_string(),
+                "Executable : " + self.version_string(),
                 " ",
-                self.client_version_string(),
+                "rips : " + self.client_version_string(),
             )
 
     def __version_message(self) -> App_pb2.Version:

docs/rips/instance.py

@@ -511,3 +511,13 @@ def update(self) -> None:
             raise Exception(
                 "Object is not connected to GRPC service so cannot update ResInsight"
             )
+
+    def delete(self) -> None:
+        """Delete object in ResInsight"""
+        self.__copy_to_pb2()
+        if self._pdm_object_stub is not None:
+            self._pdm_object_stub.DeleteExistingPdmObject(self._pb2_object)
+        else:
+            raise Exception(
+                "Object is not connected to GRPC service so cannot update ResInsight"
+            )

docs/rips/pdmobject.py

@@ -1,6 +1,7 @@
 """
 ResInsight 2d plot module
 """
+
 import Commands_pb2
 
 from .pdmobject import add_method

docs/rips/plot.py

@@ -1,6 +1,7 @@
 """
 ResInsight SimulationWell
 """
+
 import grpc
 
 import SimulationWell_pb2

docs/rips/simulation_well.py

@@ -0,0 +1,27 @@
+import sys
+import os
+
+sys.path.insert(1, os.path.join(sys.path[0], "../../"))
+import rips
+
+
+def test_well_path(rips_instance, initialize_test):
+    well_path_coll = rips_instance.project.descendants(rips.WellPathCollection)[0]
+    assert len(well_path_coll.well_paths()) is 0
+
+    well_path = well_path_coll.add_new_object(rips.ModeledWellPath)
+    well_path2 = well_path_coll.add_new_object(rips.ModeledWellPath)
+    assert len(well_path_coll.well_paths()) is 2
+
+    well_path.delete()
+    assert len(well_path_coll.well_paths()) is 1
+
+    try:
+        # Delete again should throw exception
+        well_path.delete()
+        assert False
+    except Exception:
+        assert True
+
+    well_path2.delete()
+    assert len(well_path_coll.well_paths()) is 0