marshalling detailed report env variable documented

Author: OutlyingWest

README.md

@@ -152,6 +152,7 @@ MODE=[disk,memory]
 ```
 
 When using persistence in `disk` mode, user can also define directory to which serializer output will be saved with `SCOREP_KERNEL_PERSISTENCE_DIR` environment variable.
+To see the detailed report for marshalling steps - `MARSHALLING_DETAILED_REPORT=1` environment variable can be set.
 
 `%%execute_with_scorep`
 

examples/ExampleBasic.ipynb

@@ -466,7 +466,57 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": []
+   "source": [
+    "### Large array processing with Score-P\n",
+    "This example illustrates the steps involved in the marshalling process when a cell instrumented with Score-P is executed with a large data payload as input.\n"
+   ]
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": [
+    "import time\n",
+    "import numpy as np\n",
+    "\n",
+    "def generate_array_with_size(size_mb, dtype=np.float32):\n",
+    "    size_bytes = size_mb * 1024 * 1024\n",
+    "    element_size = np.dtype(dtype).itemsize\n",
+    "    num_elements = size_bytes // element_size\n",
+    "    array = np.zeros(num_elements, dtype=dtype)\n",
+    "    return array\n",
+    "\n",
+    "big_array = generate_array_with_size(size_mb=1000)"
+   ]
+  },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": "Enable marshalling detailed report for each step."
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": "%env MARSHALLING_DETAILED_REPORT=1"
+  },
+  {
+   "metadata": {},
+   "cell_type": "markdown",
+   "source": "Run cell with Score-P"
+  },
+  {
+   "metadata": {},
+   "cell_type": "code",
+   "outputs": [],
+   "execution_count": null,
+   "source": [
+    "%%execute_with_scorep\n",
+    "big_array\n",
+    "time.sleep(4)"
+   ]
   }
  ],
  "metadata": {