Update rips module, proto files, and Python examples

Author: magnesj

docs/rips/PythonExamples/wells_and_fractures/create_surface_from_thermal_fracture.py

@@ -94,7 +94,7 @@ def export_surface_as_ts_file(surf, point_cloud, properties, path):
 for fracture in fractures:
     fracture_name = fracture.user_description
 
-    # Create the ouput directory
+    # Create the output directory
     output_directory = (
         Path(home_dir) / "thermal_fracture_surfaces" / "{}".format(fracture_name)
     )

docs/rips/case.py

@@ -540,9 +540,9 @@ def create_lgr_for_completion(
         --------------- | -------------------------------------- | -----
         time_steps      | Time step index                        | Integer
         well_path_names | List of well path names                | List of Strings
-        refinement_i    | Refinment in x-direction               | Integer
-        refinement_j    | Refinment in y-direction               | Integer
-        refinement_k    | Refinment in z-direction               | Integer
+        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**::

docs/rips/generated/generated_classes.py

@@ -217,13 +217,13 @@ class SurfaceInterface(PdmObjectBase):
     """
     Attributes:
         depth_offset (float): Depth Offset
-        surface_user_decription (str): Name
+        surface_user_description (str): Name
     """
     __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:
         self.depth_offset: float = 0.000000000000000e+00
-        self.surface_user_decription: str = ""
+        self.surface_user_description: str = ""
         PdmObjectBase.__init__(self, pb2_object, channel)
         if SurfaceInterface.__custom_init__ is not None:
             SurfaceInterface.__custom_init__(self, pb2_object=pb2_object, channel=channel)
@@ -404,12 +404,12 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
 class SurfaceCollection(PdmObjectBase):
     """
     Attributes:
-        surface_user_decription (str): Name
+        surface_user_description (str): Name
     """
     __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:
-        self.surface_user_decription: str = "Surfaces"
+        self.surface_user_description: str = "Surfaces"
         PdmObjectBase.__init__(self, pb2_object, channel)
         if SurfaceCollection.__custom_init__ is not None:
             SurfaceCollection.__custom_init__(self, pb2_object=pb2_object, channel=channel)
@@ -777,7 +777,7 @@ def append_fracture_template(self, file_path: str="") -> StimPlanFractureTemplat
         Create a new StimPlan Fracture Template
 
         Arguments:
-            file_path (str): File Path to StimPlan Countour File
+            file_path (str): File Path to StimPlan Contour File
         Returns:
             StimPlanFractureTemplate
         """

docs/rips/simulation_well.py

@@ -79,7 +79,7 @@ def cells(
 
 @add_method(SimulationWell)
 def accumulated_perforation_length(self: SimulationWell, timestep: int) -> float:
-    """Get accumulated perforation lenght for the given timestep.
+    """Get accumulated perforation length for the given timestep.
        If a well is closed the length will be 0.
 
     Arguments:

docs/rips/tests/test_surfaces.py

@@ -76,7 +76,7 @@ def test_create_regular_surface(rips_instance, initialize_test):
     ):
         s.set_property("property_too_big", [i for i in range(nx * ny * 2)])
 
-    # Sucessfully set the depth property
+    # Successfully set the depth property
     s.set_property("depth", [i for i in range(nx * ny)])
     s.set_property_as_depth("depth")
 

docs/rips/tests/test_wells_path_completions.py

@@ -88,7 +88,7 @@ def test_add_well_path_completions(rips_instance, initialize_test):
 
 def test_add_well_path_fracture_template(rips_instance, initialize_test):
     # Add test for all properties
-    # Some properties depend on availablility of other data and is not tested, these tests are commented out
+    # Some properties depend on availability of other data and is not tested, these tests are commented out
 
     fracture_template = rips_instance.project.descendants(rips.FractureTemplate)[0]
     fracture_template.azimuth_angle = 23.0