kernel multiple trace viewers logic, calls and description

Author: OutlyingWest

README.md

@@ -137,14 +137,14 @@ Executes a cell with Score-P, i.e. it calls `python -m scorep <cell code>`
 To automatically launch **Vampir** after a cell with Score-P instrumentation, use:
 
 ```
-%%enable_vampir_launch_on_scorep_instrumented
+%%enable_scorep_trace_viewer
 ```
 
 This will cause the kernel to open `traces.otf2` in Vampir (if found) after the next instrumented cell.  
 To disable this behavior again:
 
 ```
-%%disable_vampir_launch
+%%disable_scorep_trace_viewer
 ```
 
 By default, Vampir launching is disabled. You must enable it explicitly when needed.

src/scorep_jupyter/kernel.py

@@ -94,15 +94,25 @@ def __init__(self, **kwargs):
         self.writefile_scorep_binding_args = []
         self.writefile_multicell = False
 
+        # Score-P
         self.scorep_available_ = shutil.which("scorep")
         self.scorep_python_available_ = True
         try:
             importlib.import_module("scorep")
         except ModuleNotFoundError:
             self.scorep_python_available_ = False
-        self.launch_vampir_requested = False
-        logging.config.dictConfig(LOGGING)
+
+        # Traces
+        self.visualize_traces_requested = False
+        self.trace_viewer = "default"
+        self.trace_viewers = {
+            "default",
+            "vampir"
+        }
+
+        # Logging
         self.log = logging.getLogger("kernel")
+        logging.config.dictConfig(LOGGING)
 
     def cell_output(self, string, stream="stdout"):
         """
@@ -637,8 +647,8 @@ async def scorep_execute(
         self.pershelper.postprocess()
 
         # Optional Vampir launch
-        if self.launch_vampir_requested and scorep_folder:
-            self.try_launch_vampir(scorep_folder)
+        if self.visualize_traces_requested and scorep_folder:
+            self._view_scorep_traces(scorep_folder, self.trace_viewer)
 
         return self.standard_reply()
 
@@ -790,7 +800,7 @@ def handle_captured_output(self, output: List[str], stream: str):
             else:
                 self.log.error(f"Undefined stream type: {stream}")
 
-    def try_launch_vampir(self, scorep_folder: str):
+    def _view_scorep_traces(self, scorep_folder: str, viewer = "default"):
         """
         Attempts to find traces.otf2 and launch Vampir on it.
         Errors are logged using log_error().
@@ -808,6 +818,22 @@ def try_launch_vampir(self, scorep_folder: str):
             )
             return
 
+        if viewer not in self.trace_viewers:
+            self.log_error(
+                KernelErrorCode.UNSUPPORTED_VIEWER,
+                scorep_folder=scorep_folder,
+                viewer=viewer,
+                supported_viewers="default, vampir",
+            )
+            return
+
+        if viewer == "default":
+            self._default_view_traces(trace_path)
+        elif viewer == "vampir":
+            self._try_launch_vampir(trace_path)
+
+
+    def _try_launch_vampir(self, trace_path: str):
         if shutil.which("vampir") is None:
             self.log_error(KernelErrorCode.VAMPIR_NOT_FOUND)
             return
@@ -822,6 +848,9 @@ def try_launch_vampir(self, scorep_folder: str):
                 exception=str(e),
             )
 
+    def _default_view_traces(self, trace_path: str):
+        print('Default viewer launched')
+
     async def do_execute(
         self,
         code,
@@ -898,17 +927,35 @@ async def do_execute(
         elif code.startswith("%%end_writefile"):
             return self.scorep_not_available() or self.end_writefile()
 
-        elif code.startswith("%%enable_vampir_launch_on_scorep_instrumented"):
-            self.launch_vampir_requested = True
-            if shutil.which("vampir") is None:
-                self.log_error(KernelErrorCode.VAMPIR_NOT_FOUND)
+        elif code.startswith("%%enable_scorep_trace_viewer"):
+            # Enable Score-P trace viewer, with optional argument: 'vampir'
+            self.visualize_traces_requested = True
+            first_line = code.split("\n", 1)[0].strip()
+            parts = first_line.split()
+            requested_viewer = parts[1].lower() if len(parts) > 1 else "default"
+
+            if requested_viewer not in self.trace_viewers:
+                self.log_error(
+                    KernelErrorCode.UNSUPPORTED_VIEWER,
+                    viewer=requested_viewer,
+                    supported_viewers=", ".join(self.trace_viewers),
+                )
+                self.trace_viewer = "default"
             else:
-                self.cell_output("Vampir will be launched after next "
-                                 "instrumented execution.")
+                if requested_viewer == "vampir" and shutil.which("vampir") is None:
+                    self.log_error(KernelErrorCode.VAMPIR_NOT_FOUND)
+                    # Fallback to default viewer
+                    self.trace_viewer = "default"
+                else:
+                    self.trace_viewer = requested_viewer
+
+            self.cell_output(
+                f"Score-P trace viewer set to: {self.trace_viewer}"
+            )
             return self.standard_reply()
-        elif code.startswith("%%disable_vampir_launch"):
-            self.launch_vampir_requested = False
-            self.cell_output("Vampir launching disabled.")
+        elif code.startswith("%%disable_scorep_trace_viewer"):
+            self.visualize_traces_requested = False
+            self.cell_output("Score-P trace viewer disabled.")
             return self.standard_reply()
         elif code.startswith("%%execute_with_scorep"):
             scorep_missing = self.scorep_not_available()

src/scorep_jupyter/kernel_messages.py

@@ -13,6 +13,7 @@ class KernelErrorCode(Enum):
     SCOREP_PYTHON_NOT_AVAILABLE = auto()
     VAMPIR_NOT_FOUND = auto()
     VAMPIR_LAUNCH_FAILED = auto()
+    UNSUPPORTED_VIEWER = auto()
 
 
 KERNEL_ERROR_MESSAGES = {
@@ -43,6 +44,9 @@ class KernelErrorCode(Enum):
         "Instrumentation output directory not found or missing traces.otf2 "
         "(looked in: {scorep_folder})"
     ),
+    KernelErrorCode.UNSUPPORTED_VIEWER: (
+        "Unsupported viewer '{viewer}'. Supported viewers: {supported_viewers}."
+    ),
     KernelErrorCode.VAMPIR_NOT_FOUND: (
         'Vampir binary not found in PATH. Add it to PATH to enable '
         'automatic launch'