add scorep dependency, renaming

Author: Elias Werner

.github/workflows/unit_test.yml

@@ -42,10 +42,10 @@ jobs:
           pip install pyyaml dill cloudpickle numpy pandas
           pip install ipywidgets itables matplotlib pynvml
 
-      - name: Build JUmPER kernel
+      - name: Build scorep_jupyter kernel
         run: |
           pip install .
-          python -m jumper.install
+          python -m scorep_jupyter.install
         
       - name: Run userpersistence tests
         run: |

examples/ExampleBasic.ipynb

@@ -503,7 +503,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%env JUMPER_MARSHALLING_DETAILED_REPORT=1"
+    "%env scorep_jupyter_MARSHALLING_DETAILED_REPORT=1"
    ]
   },
   {
@@ -527,9 +527,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "JUmPER",
+   "display_name": "scorep_jupyter",
    "language": "python",
-   "name": "jumper"
+   "name": "scorep_jupyter"
   },
   "language_info": {
    "file_extension": ".py",

examples/gpt-demo/01-GPT-Training.ipynb

@@ -184,9 +184,9 @@
    "lastKernelId": null
   },
   "kernelspec": {
-   "display_name": "JUmPER",
+   "display_name": "scorep_jupyter",
    "language": "python",
-   "name": "jumper"
+   "name": "scorep_jupyter"
   },
   "language_info": {
    "file_extension": ".py",

pyproject.toml

@@ -6,8 +6,8 @@ requires = [
 build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
-name='jumper-kernel'
-version='1.1.1'
+name='scorep-jupyter'
+version='1.2.0'
 authors=[
   {name='Elias Werner',email='elias.werner@tu-dresden.de'},
 ]
@@ -23,7 +23,8 @@ dependencies = [
   "ipykernel",
   "jupyter-client",
   "astunparse",
-  "dill"
+  "dill",
+  "scorep"
 ]
 
 [project.urls]

src/parallel_marshall/parallel_marshall.py

@@ -10,16 +10,16 @@
 # mode is automatically determined by the file object that is passed for
 # dumping
 mode = ""
-backend = str(os.environ.get("JUMPER_PARALLEL_MARSHALL_BACKEND", "dill"))
-if os.environ.get("JUMPER_PARALLEL_MARSHALL_NWORKERS"):
+backend = str(os.environ.get("scorep_jupyter_PARALLEL_MARSHALL_BACKEND", "dill"))
+if os.environ.get("scorep_jupyter_PARALLEL_MARSHALL_NWORKERS"):
     workers = min(
-        int(os.environ.get("JUMPER_PARALLEL_MARSHALL_NWORKERS")),
+        int(os.environ.get("scorep_jupyter_PARALLEL_MARSHALL_NWORKERS")),
         multiprocessing.cpu_count(),
         multiprocessing.cpu_count(),
     )
 else:
     workers = multiprocessing.cpu_count()
-debug = int(os.environ.get("JUMPER_PARALLEL_MARSHALL_DEBUG", 20))
+debug = int(os.environ.get("scorep_jupyter_PARALLEL_MARSHALL_DEBUG", 20))
 
 logger = logging.getLogger(__name__)
 logging.basicConfig(filename="parallel_marshall.log", level=logging.INFO)

src/scorep_jupyter/install.py

@@ -3,7 +3,7 @@
 import os
 import sys
 import json
-from jumper.logo import logo_image
+from scorep_jupyter.logo import logo_image
 
 kernel_spec = {
     "argv": [sys.executable, "-m", "scorep_jupyter.kernel", "-f", "{connection_file}"],

src/scorep_jupyter/kernel.py

@@ -13,17 +13,17 @@
 from enum import Enum
 from textwrap import dedent
 from ipykernel.ipkernel import IPythonKernel
-from jumper.userpersistence import PersHelper, scorep_script_name
-from jumper.userpersistence import magics_cleanup, create_busy_spinner
+from scorep_jupyter.userpersistence import PersHelper, scorep_script_name
+from scorep_jupyter.userpersistence import magics_cleanup, create_busy_spinner
 import importlib
-from jumper.kernel_messages import KernelErrorCode, KERNEL_ERROR_MESSAGES
+from scorep_jupyter.kernel_messages import KernelErrorCode, KERNEL_ERROR_MESSAGES
 
-# import jumper.multinode_monitor.slurm_monitor as slurm_monitor
+# import scorep_jupyter.multinode_monitor.slurm_monitor as slurm_monitor
 
 from .logging_config import LOGGING
 
 PYTHON_EXECUTABLE = sys.executable
-userpersistence_token = "jumper.userpersistence"
+userpersistence_token = "scorep_jupyter.userpersistence"
 jupyter_dump = "jupyter_dump.pkl"
 subprocess_dump = "subprocess_dump.pkl"
 
@@ -38,7 +38,7 @@ def __str__(self):
         return self.value[1]
 
 
-class JumperKernel(IPythonKernel):
+class scorep_jupyterKernel(IPythonKernel):
     implementation = "Python and Score-P"
     implementation_version = "1.0"
     language = "python"
@@ -305,7 +305,7 @@ def start_writefile(self, code):
                         f"""
                         # This bash script is generated automatically to run
                         # Jupyter Notebook -> Python script conversion
-                        # by JUmPER kernel
+                        # by scorep_jupyter kernel
                         # {self.writefile_python_name}
                         # !/bin/bash
                         """
@@ -322,7 +322,7 @@ def start_writefile(self, code):
                     dedent(
                         f"""
                         # This is the automatic conversion of
-                        # Jupyter Notebook -> Python script by JUmPER kernel.
+                        # Jupyter Notebook -> Python script by scorep_jupyter kernel.
                         # Code corresponding to the cells not marked for
                         # Score-P instrumentation is framed by
                         # "with scorep.instrumenter.disable()
@@ -880,4 +880,4 @@ def log_error(self, code: KernelErrorCode, **kwargs):
 if __name__ == "__main__":
     from ipykernel.kernelapp import IPKernelApp
 
-    IPKernelApp.launch_instance(kernel_class=JumperKernel)
+    IPKernelApp.launch_instance(kernel_class=scorep_jupyterKernel)

src/scorep_jupyter/logging_config.py

@@ -17,9 +17,9 @@ def filter(self, record):
         return record.levelno < logging.ERROR
 
 
-class JumperKernelOnlyFilter(logging.Filter):
+class scorep_jupyterKernelOnlyFilter(logging.Filter):
     def filter(self, record):
-        return "jumper" in record.pathname
+        return "scorep_jupyter" in record.pathname
 
 
 LOGGING = {
@@ -57,14 +57,14 @@ def filter(self, record):
             "filters": [
                 "ignore_error_filter",  # prevents from writing to jupyter
                 # cell output twice
-                "jumper_kernel_only_filter",
+                "scorep_jupyter_kernel_only_filter",
             ],
         },
     },
     "filters": {
         "jupyter_filter": {"()": JupyterLogFilter},
         "ignore_error_filter": {"()": IgnoreErrorFilter},
-        "jumper_kernel_only_filter": {"()": JumperKernelOnlyFilter},
+        "scorep_jupyter_kernel_only_filter": {"()": scorep_jupyterKernelOnlyFilter},
     },
     "root": {
         "handlers": [],

src/scorep_jupyter/userpersistence.py

@@ -44,7 +44,7 @@ def preprocess(self):
             for key2 in self.paths[key1]:
 
                 if self.mode == "memory":
-                    fd_path = "jumper_" + key1 + "_" + key2 + "_" + uid
+                    fd_path = "scorep_jupyter_" + key1 + "_" + key2 + "_" + uid
                 elif self.mode == "disk":
                     fd_path = dir_path + "_" + key2 + "_" + uid
 
@@ -114,7 +114,7 @@ def jupyter_dump(self):
             "import os\n"
             "import threading\n"
             f"import {self.marshaller}\n"
-            "from jumper.userpersistence import dump_runtime, "
+            "from scorep_jupyter.userpersistence import dump_runtime, "
             "dump_variables, create_busy_spinner\n"
             "spinner = create_busy_spinner()\n"
             f"if {self.is_dump_detailed_report}:\n"
@@ -152,7 +152,7 @@ def subprocess_wrapper(self, code):
             "import sys\n"
             "import os\n"
             f"import {self.marshaller}\n"
-            "from jumper.userpersistence import dump_runtime,"
+            "from scorep_jupyter.userpersistence import dump_runtime,"
             "dump_variables, load_runtime, load_variables\n"
             "load_runtime(os.environ, sys.path,"
             f"'{self.paths['jupyter']['os_environ']}',"
@@ -195,7 +195,7 @@ def jupyter_update(self, code):
         jupyter_update = (
             "import sys\n"
             "import os\n"
-            "from jumper.userpersistence import load_runtime, load_variables\n"
+            "from scorep_jupyter.userpersistence import load_runtime, load_variables\n"
             f"load_runtime(os.environ, sys.path,"
             f"'{self.paths['subprocess']['os_environ']}',"
             f"'{self.paths['subprocess']['sys_path']}',{self.marshaller})\n"
@@ -231,7 +231,7 @@ def parse(self, code, mode):
 
     def set_dump_report_level(self):
         self.is_dump_detailed_report = int(
-            os.getenv("JUMPER_MARSHALLING_DETAILED_REPORT", "0")
+            os.getenv("scorep_jupyter_MARSHALLING_DETAILED_REPORT", "0")
         )
 
 
@@ -306,7 +306,7 @@ def extract_definitions(code):
     Extract imported modules and definitions of classes and functions from
     the code block.
     """
-    # can't use in kernel as import from jumper.userpersistence:
+    # can't use in kernel as import from scorep_jupyter.userpersistence:
     # self-reference error during dill dump of notebook
     root = ast.parse(code)
     definitions = []
@@ -488,7 +488,7 @@ def stop(self, done_message="Done."):
 
 
 def create_busy_spinner(lock=None):
-    is_enabled = os.getenv("JUMPER_DISABLE_PROCESSING_ANIMATIONS") != "1"
+    is_enabled = os.getenv("scorep_jupyter_DISABLE_PROCESSING_ANIMATIONS") != "1"
     if is_enabled:
         return BusySpinner(lock)
     else:

tests/kernel/notebook.ipynb

@@ -810,9 +810,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "JUmPER",
+   "display_name": "scorep_jupyter",
    "language": "python",
-   "name": "jumper"
+   "name": "scorep_jupyter"
   },
   "language_info": {
    "file_extension": ".py",