Update rips module, proto files, and Python examples

Author: magnesj

docs/rips/PythonExamples/case_and_grid_operations/polygon_region_from_project.py

@@ -27,9 +27,7 @@ def point_in_polygon_2d(px, py, polygon_xy):
     for i in range(n):
         xi, yi = polygon_xy[i][0], polygon_xy[i][1]
         xj, yj = polygon_xy[j][0], polygon_xy[j][1]
-        if ((yi > py) != (yj > py)) and (
-            px < (xj - xi) * (py - yi) / (yj - yi) + xi
-        ):
+        if ((yi > py) != (yj > py)) and (px < (xj - xi) * (py - yi) / (yj - yi) + xi):
             inside = not inside
         j = i
     return inside

docs/rips/PythonExamples/wells_and_fractures/add_valve.py

@@ -0,0 +1,46 @@
+"""
+Example demonstrating how to create a stand-alone ICV valve,
+shut it and move it deeper
+"""
+
+import rips
+
+rips_instance = rips.Instance.find()
+well_path_coll = rips_instance.project.well_path_collection()
+
+# Create main well path using ModeledWellPath with targets
+main_well_path = well_path_coll.add_new_object(rips.ModeledWellPath)
+main_well_path.name = "main_well_check_connection"
+main_well_path.update()
+
+# Add geometry targets to main well path
+main_geometry = main_well_path.well_path_geometry()
+main_geometry.append_well_target([1000.0, 2000.0, 0.0])  # Surface
+main_geometry.append_well_target([1000.0, 2000.0, -100.0])  # 100m down
+main_geometry.append_well_target([1000.0, 2000.0, -300.0])  # 300m down
+main_geometry.append_well_target([1000.0, 2000.0, -500.0])  # 500m down
+main_geometry.use_auto_generated_target_at_sea_level = False
+main_geometry.update()
+
+# Add a stand-alone valve at md 240
+valve = main_well_path.add_icv_valve(240.0)
+
+# default for valve should be open
+if valve.is_open:
+    print("Valve %s is open!" % valve.name)
+else:
+    print("Valve shut!")
+
+# close valve and move it to md = 275
+valve.is_open = False
+valve.start_measured_depth = 275
+valve.update()
+
+# valve should now be shut
+if valve.is_open:
+    print("Valve %s is open!" % valve.name)
+else:
+    print("Valve shut!")
+
+# valve should be at md = 275
+print("Valve measured depth: " + str(valve.start_measured_depth))

docs/rips/PythonExamples/wells_and_fractures/tie_in_example.py

@@ -0,0 +1,56 @@
+"""
+Example demonstrating how to create well paths from XYZ coordinates
+and add a tie-in valve, adjusting the valve MD to a custom value.
+"""
+
+import rips
+
+rips_instance = rips.Instance.find()
+
+
+well_path_coll = rips_instance.project.well_path_collection()
+
+# Create main well path using ModeledWellPath with targets
+main_well_path = well_path_coll.add_new_object(rips.ModeledWellPath)
+main_well_path.name = "main_well_check_connection"
+main_well_path.update()
+
+# Add geometry targets to main well path
+main_geometry = main_well_path.well_path_geometry()
+main_geometry.append_well_target([1000.0, 2000.0, 0.0])  # Surface
+main_geometry.append_well_target([1000.0, 2000.0, -100.0])  # 100m down
+main_geometry.append_well_target([1000.0, 2000.0, -300.0])  # 300m down
+main_geometry.append_well_target([1000.0, 2000.0, -500.0])  # 500m down
+main_geometry.use_auto_generated_target_at_sea_level = False
+main_geometry.update()
+
+measured_depth = 150
+lateral = main_well_path.append_lateral(measured_depth)
+
+# Get the valve template collection
+valve_templates = rips_instance.project.valve_templates()
+
+# create an ICV valve template
+icv_template = valve_templates.add_template(
+    completion_type="ICV",
+    orifice_diameter=12.5,
+    flow_coefficient=0.85,
+    user_label="Custom ICV for Lateral",
+)
+
+# Enable well valve
+valve = lateral.enable_outlet_valve(
+    enable=True, icv_template=icv_template, use_custom_valve_md=False
+)
+
+# Enable a custom md for the outlet valve
+tiein = lateral.tie_in()
+
+custom_enabled, custom_md = tiein.custom_outlet_valve_md
+print("Custom outlet valve md: " + str(custom_enabled))
+
+tiein.custom_outlet_valve_md = (True, 200.0)
+tiein.update()
+
+custom_enabled, custom_md = tiein.custom_outlet_valve_md
+print("Custom outlet valve md: " + str(custom_enabled) + " at " + str(custom_md))

docs/rips/__init__.py

@@ -1,33 +1,32 @@
 import logging
 import os
 import sys
+from typing import List
 
 # Configure null handler to prevent "No handler found" warnings
 logging.getLogger("rips").addHandler(logging.NullHandler())
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "generated"))
 
-from .resinsight_classes import *  # noqa: F403
+from .resinsight_classes import *  # noqa: F403, E402
 
-from .case import Case as Case, EclipseCase as EclipseCase, GeoMechCase as GeoMechCase
-from .grid import Grid as Grid
-from .instance import Instance as Instance
-from .view import View as View
-from .project import Project as Project
-from .plot import Plot as Plot, PlotWindow as PlotWindow
-from .contour_map import (
+from .case import Case as Case, EclipseCase as EclipseCase, GeoMechCase as GeoMechCase  # noqa: E402
+from .grid import Grid as Grid  # noqa: E402
+from .instance import Instance as Instance  # noqa: E402
+from .view import View as View  # noqa: E402
+from .project import Project as Project  # noqa: E402
+from .plot import Plot as Plot, PlotWindow as PlotWindow  # noqa: E402
+from .contour_map import (  # noqa: E402
     EclipseContourMap as EclipseContourMap,
     GeoMechContourMap as GeoMechContourMap,
 )
-from .well_log_plot import WellLogPlot as WellLogPlot
-from .well_path import WellPath as WellPath
-from . import well_path_collection as well_path_collection  # noqa: F401
-from .simulation_well import SimulationWell as SimulationWell
-from .exception import RipsError as RipsError
-from .surface import RegularSurface as RegularSurface
-from . import well_events as well_events  # noqa: F401
-
-from typing import List
+from .well_log_plot import WellLogPlot as WellLogPlot  # noqa: E402
+from .well_path import WellPath as WellPath  # noqa: E402
+from . import well_path_collection as well_path_collection  # noqa: F401, E402
+from .simulation_well import SimulationWell as SimulationWell  # noqa: E402
+from .exception import RipsError as RipsError  # noqa: E402
+from .surface import RegularSurface as RegularSurface  # noqa: E402
+from . import well_events as well_events  # noqa: F401, E402
 
 __all__: List[str] = []
 for key in class_dict():  # noqa: F405