Enable tutorials on Windows

tutorials/in_depth/tutorial02_processes.ipynb

@@ -90,7 +90,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "id": "685af4da",
    "metadata": {},
    "outputs": [],
@@ -165,7 +165,35 @@
    "execution_count": 2,
    "id": "bb4835e1",
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:13: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  a_in: PyInPort = LavaPyType(PyInPort.VEC_DENSE, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:15: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  u: np.ndarray = LavaPyType(np.ndarray, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:16: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  v: np.ndarray = LavaPyType(np.ndarray, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:17: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  bias: np.ndarray = LavaPyType(np.ndarray, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:18: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  du: float = LavaPyType(float, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:19: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  dv: float = LavaPyType(float, np.float)\n",
+      "C:\\Users\\pplank\\AppData\\Local\\Temp\\ipykernel_3388\\2851907654.py:20: DeprecationWarning: `np.float` is a deprecated alias for the builtin `float`. To silence this warning, use `float` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.float64` here.\n",
+      "Deprecated in NumPy 1.20; for more details and guidance: https://numpy.org/devdocs/release/1.20.0-notes.html#deprecations\n",
+      "  vth: float = LavaPyType(float, np.float)\n"
+     ]
+    }
+   ],
    "source": [
     "import numpy as np\n",
     "from lava.magma.core.sync.protocols.loihi_protocol import LoihiProtocol\n",
@@ -199,6 +227,31 @@
     "        self.s_out.send(s_out)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "e62a6fd4",
+   "metadata": {},
+   "source": [
+    "#### Exception for Windows\n",
+    "\n",
+    "The next cell is only needed for systems running on Windows. This is not part of the tutorial or Lava, but to allow this jupyter notebook to execute on Windows without errors. The class LIF and PyLifModel need to be imported from a script in order to run this tutorial on Windows due to an issue with the multiprocessing package on Windows. Therefore we create a python script from this jupyter notebook and import the classes defined above from there.\n",
+    "With this solution you can still modify the classes above and rerun the notebook to see the changes!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "2a1837e9",
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "from win_exec import enable_win, cleanup\n",
+    "enable_win(\"tutorial02_processes\")\n",
+    "from tutorial02_processes import LIF"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "a27ae936",
@@ -211,7 +264,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "2d14869c",
    "metadata": {},
    "outputs": [],
@@ -237,7 +290,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "27e749ec",
    "metadata": {},
    "outputs": [
@@ -273,7 +326,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "6ae84fef",
    "metadata": {},
    "outputs": [
@@ -309,7 +362,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "f25e0cd9",
    "metadata": {},
    "outputs": [],
@@ -330,7 +383,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "id": "110b9196",
    "metadata": {},
    "outputs": [
@@ -358,7 +411,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "id": "4cb4d6bb",
    "metadata": {},
    "outputs": [
@@ -389,7 +442,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 10,
    "id": "31b51fb7",
    "metadata": {},
    "outputs": [],
@@ -410,6 +463,25 @@
     "\n",
     "To receive regular updates on the latest developments and releases of the Lava Software Framework please subscribe to the [INRC newsletter](http://eepurl.com/hJCyhb \"INRC Newsletter\")."
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "663b1e84",
+   "metadata": {},
+   "source": [
+    "#### Exception for Windows\n",
+    "Delete the created python script again."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "326cc579",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cleanup(\"tutorial02_processes\")"
+   ]
   }
  ],
  "metadata": {
@@ -428,7 +500,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.10"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

tutorials/in_depth/win_exec.py

@@ -0,0 +1,37 @@
+# Copyright (C) 2022 Intel Corporation
+# SPDX-License-Identifier: BSD-3-Clause
+# See: https://spdx.org/licenses/
+
+from sys import platform
+import os
+
+
+def enable_win(nb_name: str):
+    """Enables execution of Lava tutorials on Windows systems. Processes
+    defined within the tutorial jupyter notebook need to be written to a python
+    script and imported in the notebook again."""
+    if platform == "win32" or platform == "cygwin":
+        # Convert the ipython notebook to a python script
+        os.system("jupyter nbconvert --to script " + nb_name + ".ipynb")
+
+        # Remove code after definition to avoid execution during import
+        with open(nb_name + ".py", "r+") as f:
+            d = f.readlines()
+            f.seek(0)
+            for i in d:
+                if i.strip("\n") != "# #### Exception for Windows":
+                    f.write(i)
+                elif i.strip("\n") == "# #### Exception for Windows":
+                    break
+            f.truncate()
+
+
+def cleanup(nb_name: str):
+    """Removes previously created python script for tutorial execution on
+    Windows systems."""
+    if platform == "win32" or platform == "cygwin":
+        os.system("del " + nb_name + ".py")
+
+
+if __name__ == "__main__":
+    pass