Jumper evironment variables names enriched by JUMPER_* prefix

Author: OutlyingWest

README.md

@@ -155,13 +155,13 @@ When using persistence in `disk` mode, user can also define directory to which s
 ```
 %env SCOREP_KERNEL_PERSISTENCE_DIR=path/to/dir
 ```
-To see the detailed report for marshalling steps - `MARSHALLING_DETAILED_REPORT` environment variable can be set.
+To see the detailed report for marshalling steps - `JUMPER_MARSHALLING_DETAILED_REPORT` environment variable can be set.
 ```
-%env MARSHALLING_DETAILED_REPORT=1
+%env JUMPER_MARSHALLING_DETAILED_REPORT=1
 ```
-You can disable visual animations shown during long-running tasks by setting the `DISABLE_PROCESSING_ANIMATIONS` environment variable.
+You can disable visual animations shown during long-running tasks by setting the `JUMPER_DISABLE_PROCESSING_ANIMATIONS` environment variable.
 ```
-%env DISABLE_PROCESSING_ANIMATIONS=1
+%env JUMPER_DISABLE_PROCESSING_ANIMATIONS=1
 ```
 
 `%%execute_with_scorep`

examples/ExampleBasic.ipynb

@@ -472,10 +472,10 @@
    ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
+   "metadata": {},
+   "outputs": [],
    "source": [
     "import time\n",
     "import numpy as np\n",
@@ -491,27 +491,33 @@
    ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
-   "source": "Enable marshalling detailed report for each step."
+   "metadata": {},
+   "source": [
+    "Enable marshalling detailed report for each step."
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
-   "source": "%env MARSHALLING_DETAILED_REPORT=1"
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%env JUMPER_MARSHALLING_DETAILED_REPORT=1"
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
-   "source": "Run cell with Score-P"
+   "metadata": {},
+   "source": [
+    "Run cell with Score-P"
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "code",
-   "outputs": [],
    "execution_count": null,
+   "metadata": {},
+   "outputs": [],
    "source": [
     "%%execute_with_scorep\n",
     "big_array\n",
@@ -521,14 +527,14 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "scorep-python",
+   "display_name": "JUmPER",
    "language": "python",
-   "name": "scorep-python"
+   "name": "jumper"
   },
   "language_info": {
    "file_extension": ".py",
    "mimetype": "text/plain",
-   "name": "Any text"
+   "name": "python"
   }
  },
  "nbformat": 4,

src/jumper/userpersistence.py

@@ -227,7 +227,7 @@ def parse(self, code, mode):
             self.jupyter_variables.extend(user_variables)
 
     def set_dump_report_level(self):
-        self.is_dump_detailed_report = int(os.getenv('MARSHALLING_DETAILED_REPORT', '0'))
+        self.is_dump_detailed_report = int(os.getenv('JUMPER_MARSHALLING_DETAILED_REPORT', '0'))
 
 
 def dump_runtime(
@@ -450,7 +450,7 @@ def stop(self, done_message='Done.'):
 
 
 def create_busy_spinner(lock=None):
-    is_enabled = os.getenv("DISABLE_PROCESSING_ANIMATIONS") != "1"
+    is_enabled = os.getenv("JUMPER_DISABLE_PROCESSING_ANIMATIONS") != "1"
     if is_enabled:
         return BusySpinner(lock)
     else:

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("PARALLEL_MARSHALL_BACKEND", "dill"))
-if os.environ.get("PARALLEL_MARSHALL_NWORKERS"):
+backend = str(os.environ.get("JUMPER_PARALLEL_MARSHALL_BACKEND", "dill"))
+if os.environ.get("JUMPER_PARALLEL_MARSHALL_NWORKERS"):
     workers = min(
-        int(os.environ.get("PARALLEL_MARSHALL_NWORKERS")),
+        int(os.environ.get("JUMPER_PARALLEL_MARSHALL_NWORKERS")),
         multiprocessing.cpu_count(),
         multiprocessing.cpu_count(),
     )
 else:
     workers = multiprocessing.cpu_count()
-debug = int(os.environ.get("PARALLEL_MARSHALL_DEBUG", 20))
+debug = int(os.environ.get("JUMPER_PARALLEL_MARSHALL_DEBUG", 20))
 
 logger = logging.getLogger(__name__)
 logging.basicConfig(filename="parallel_marshall.log", level=logging.INFO)

tests/test_kernel.py

@@ -17,7 +17,7 @@ class KernelTests(jkt.KernelTests):
 
     @classmethod
     def setUpClass(cls) -> None:
-        os.environ["DISABLE_PROCESSING_ANIMATIONS"] = "1"
+        os.environ["JUMPER_DISABLE_PROCESSING_ANIMATIONS"] = "1"
         logging_config.LOGGING['loggers']['kernel']['level'] = 'WARNING'
         logging.config.dictConfig(logging_config.LOGGING)