Merge pull request #4628 from OPM/feature-python-command-line

#4610 Python: Add support for sending in command line arguments when launching ResInsight

ApplicationCode/CMakeLists.txt

@@ -713,7 +713,7 @@ if (RESINSIGHT_PRIVATE_INSTALL)
 				add_custom_command(
 					TARGET ResInsight
 					POST_BUILD
-					COMMAND ${RESINSIGHT_GRPC_PYTHON_EXECUTABLE} -m pip install --target=${CMAKE_BINARY_DIR}/Python grpcio
+					COMMAND ${RESINSIGHT_GRPC_PYTHON_EXECUTABLE} -m pip install --target=${GRPC_PYTHON_SOURCE_PATH} grpcio
 				)
 			endif()
 			install(DIRECTORY ${GRPC_PYTHON_SOURCE_PATH}/ DESTINATION ${RESINSIGHT_INSTALL_FOLDER}/Python)

ApplicationCode/GrpcInterface/CMakeLists.cmake

@@ -203,11 +203,6 @@ if (RESINSIGHT_GRPC_PYTHON_EXECUTABLE)
 			"LICENSE"
 		)
 		
-		foreach(PYTHON_SCRIPT ${GRPC_PYTHON_SOURCES})
-			# Copy into build folder so the python code is present for debugging
-			configure_file("${GRPC_PYTHON_SOURCE_PATH}/${PYTHON_SCRIPT}" "${CMAKE_BINARY_DIR}/Python/${PYTHON_SCRIPT}" COPYONLY)
-		endforeach()
-
 		list(APPEND GRPC_PYTHON_SOURCES ${GRPC_PYTHON_GENERATED_SOURCES})
 
 		foreach(PYTHON_SCRIPT ${GRPC_PYTHON_SOURCES})

ApplicationCode/GrpcInterface/Python/.gitignore

@@ -5,3 +5,6 @@ dist
 build
 rips.egg-info
 setup.py
+grpc
+grpcio*
+six*

ApplicationCode/GrpcInterface/Python/rips/Instance.py

@@ -33,7 +33,7 @@ class Instance:
             return s.connect_ex(('localhost', port)) == 0
     
     @staticmethod
-    def launch(resInsightExecutable = '', console = False):
+    def launch(resInsightExecutable = '', console = False, launchPort = -1, commandLineParameters=[]):
         """ Launch a new Instance of ResInsight. This requires the environment variable
         RESINSIGHT_EXECUTABLE to be set or the parameter resInsightExecutable to be provided.
         The RESINSIGHT_GRPC_PORT environment variable can be set to an alternative port number.
@@ -43,6 +43,9 @@ class Instance:
                 will take precedence over what is provided in the RESINSIGHT_EXECUTABLE
                 environment variable.
             console (bool): If True, launch as console application, without GUI.
+            launchPort(int): If -1 will use the default port of 50051 or look for RESINSIGHT_GRPC_PORT
+                             if anything else, ResInsight will try to launch with this port
+            commandLineParameters(list): Additional command line parameters as string entries in the list.
         Returns:
             Instance: an instance object if it worked. None if not.
         """
@@ -51,6 +54,8 @@ class Instance:
         portEnv = os.environ.get('RESINSIGHT_GRPC_PORT')
         if portEnv:
             port = int(portEnv)
+        if launchPort is not -1:
+            port = launchPort
         
         if not resInsightExecutable:
             resInsightExecutable = os.environ.get('RESINSIGHT_EXECUTABLE')
@@ -64,10 +69,19 @@ class Instance:
 
         print('Port ' + str(port))
         print('Trying to launch', resInsightExecutable)
-        parameters = ["ResInsight", "--server", str(port)]
+
+        if isinstance(commandLineParameters, str):
+            commandLineParameters = [str]
+
+        parameters = ["ResInsight", "--server", str(port)] + commandLineParameters
         if console:
             print("Launching as console app")
             parameters.append("--console")
+
+        # Stringify all parameters
+        for i in range(0, len(parameters)):
+            parameters[i] = str(parameters[i])
+
         pid = os.spawnv(os.P_NOWAIT, resInsightExecutable, parameters)
         if pid:
             instance = Instance(port=port, launched=True)

ApplicationCode/GrpcInterface/Python/rips/PythonExamples/LaunchWithCommandLineOptions.py

@@ -0,0 +1,11 @@
+# Load ResInsight Processing Server Client Library
+import rips
+# Launch ResInsight with last project file and a Window size of 600x1000 pixels
+resInsight = rips.Instance.launch(commandLineParameters=['--last', '--size', 600, 1000])
+# Get a list of all cases
+cases = resInsight.project.cases()
+
+print ("Got " + str(len(cases)) + " cases: ")
+for case in cases:
+    print("Case name: " + case.name)
+    print("Case grid path: " + case.gridPath())