Pynq v2.7 updates (#38)

* update to pynq 2.7 * remove unneeded pynq virtual env activation * update voila to v2.7 button method * Update README.md * ZCU111 Voila for pynq v2.7 Co-authored-by: Lewis Brown <lewisb@xilinx.com>
strath-sdr · Oct 29, 2021 · 21454bf · 21454bf
1 parent f64f5a4
commit 21454bf
Show file tree

Hide file tree

Showing 11 changed files with 285 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <img src="strathsdr_banner.png" width="100%">
 
 # RFSoC QPSK Transceiver
-This repository is only compatible with [PYNQ images v2.6](https://github.com/Xilinx/PYNQ/releases) for the [ZCU111](https://www.xilinx.com/products/boards-and-kits/zcu111.html) and [RFSoC2x2](http://rfsoc-pynq.io/).
+This repository is only compatible with [PYNQ images v2.7](https://github.com/Xilinx/PYNQ/releases) for the [ZCU111](https://www.xilinx.com/products/boards-and-kits/zcu111.html) and [RFSoC2x2](http://rfsoc-pynq.io/).
 
 ## Introduction
 This repo contains all the files needed to build and run the RFSoC QPSK demonstrator that was published in [IEEE Access](https://ieeexplore.ieee.org/document/9139483) and was presented at both [FPL](https://fpl2018.org/) and [XDF](http://www.xilinx.com/xdf) conferences in 2018. The design is a full QPSK transceiver, which transmits and receives randomly-generated pulse-shaped symbols with full carrier and timing synchronisation. [PYNQ](https://github.com/xilinx/pynq) is used to visualise the data at both the DAC and ADC side of the RFSoC data converters, as well as visualising various DSP stages throughout the transmit and receive signal path.
@@ -12,7 +12,7 @@ This repo contains all the files needed to build and run the RFSoC QPSK demonstr
 
 ## Quick Start
 Follow the instructions below to install the QPSK demonstrator on your development board. **You will need to give your board access to the internet**.
-* Power on your RFSoC2x2 or ZCU111 development board with an SD Card containing a fresh PYNQ v2.6 image.
+* Power on your RFSoC2x2 or ZCU111 development board with an SD Card containing a fresh PYNQ v2.7 image.
 * Navigate to Jupyter Labs by opening a browser (preferably Chrome) and connecting to `http://<board_ip_address>:9090/lab`.
 * We need to open a terminal in Jupyter Lab. Firstly, open a launcher window as shown in the figure below:
 
@@ -26,29 +26,15 @@ Follow the instructions below to install the QPSK demonstrator on your developme
   <img src="../master/open_terminal_window.jpg" width="50%" height="50%" />
 <p/>
 
-Now follow the board specific instructions as follows.
-
-## RFSoC2x2 Setup
-Your RFSoC2x2 development board does not come preinstalled with the QPSK demonstrator package (rfsoc-qpsk). You can install it by executing the command below in the terminal.
+* Now simply install the QPSK demonstrator through PIP by executing the following command in the terminal:
 
 ```sh
 pip3 install git+https://github.com/strath-sdr/rfsoc_qpsk
 ```
 
 Once installation has complete, you will find the QPSK demonstrator notebooks located in the jupyter home workspace in the `qpsk-demonstrator` folder.
 
-This repository uses Voila to create simple web applications using Jupyter notebooks. Your RFSoC2x2 development board should already be preinstalled with a version of Voila and no further setup is required.
-
-## ZCU111 Setup
-The ZCU111 PYNQ image already comes preinstalled with the QPSK demonstrator package. To use this repository correctly you should force reinstall the rfsoc-qpsk package by executing the following command in the terminal:
-
-```sh
-pip3 install --force-reinstall --no-deps git+https://github.com/strath-sdr/rfsoc_qpsk
-```
-
-Once installation has complete, you will find the QPSK demonstrator notebooks located in the jupyter home workspace in the `qpsk-demonstrator` folder.
-
-This repository uses Voila to create simple web applications using Jupyter notebooks. If you would like to use Voila on your ZCU111 development board, simply follow the instructions outlined in this [blog post](https://strath-sdr.github.io/pynq/linux/zynq/fpga/voila/2021/02/22/install-voila-on-pynq-v2-6.html).
+This repository uses Voila to create simple web applications using Jupyter notebooks. Your RFSoC2x2 or ZCU111 development board should already be preinstalled with a version of Voila and no further setup is required.
 
 ## Using the Project Files
 The following software is required to use the project files in this repository.

diff --git a/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_jupyter_launcher.jpg b/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_jupyter_launcher.jpg
diff --git a/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_terminal_window.jpg b/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_terminal_window.jpg
diff --git a/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_voila.png b/boards/RFSoC2x2/rfsoc_qpsk/notebooks/images/open_voila.png
diff --git a/boards/RFSoC2x2/rfsoc_qpsk/notebooks/rfsoc_qpsk_demonstrator.ipynb b/boards/RFSoC2x2/rfsoc_qpsk/notebooks/rfsoc_qpsk_demonstrator.ipynb
@@ -252,7 +252,7 @@
     "    symbol_quantise = lambda i, q: bit_quantise(i) + 1j*bit_quantise(q)\n",
     "    return np.fromiter(\n",
     "        map(symbol_quantise, np.real(frame), np.imag(frame)),\n",
-    "        dtype=np.complex\n",
+    "        dtype=complex\n",
     "    )\n",
     "\n",
     "ol.plot_group(\n",
@@ -464,7 +464,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.8.2"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

diff --git a/boards/RFSoC2x2/rfsoc_qpsk/notebooks/voila_rfsoc_qpsk_demonstrator.ipynb b/boards/RFSoC2x2/rfsoc_qpsk/notebooks/voila_rfsoc_qpsk_demonstrator.ipynb
@@ -3,6 +3,20 @@
   {
    "cell_type": "markdown",
    "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    },
     "tags": [
      "ignore_me"
     ]
@@ -14,6 +28,20 @@
   {
    "cell_type": "markdown",
    "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    },
     "tags": [
      "ignore_me"
     ]
@@ -74,27 +102,13 @@
     "## Running this Demonstration <a class=\"anchor\" id=\"running-this-demonstration\"></a>\n",
     "Voila can be used to execute the QPSK demonstrator and ignore all of the markdown and code cells typically found in a normal Jupyter notebook. The Voila dashboard can be launched following the instructions below:\n",
     "\n",
-    "* Open the Jupyter Quick Launch window as below:\n",
+    "* Click on the \"Open with Voila Gridstack in a new browser tab\" button at the top of the screen:\n",
     "\n",
     "<figure>\n",
-    "<img src='images/open_jupyter_launcher.jpg' height='25%' width='25%'/>\n",
+    "<img src='images/open_voila.png' height='50%' width='50%'/>\n",
     "</figure>\n",
     "\n",
-    "* Open a terminal window.\n",
-    "\n",
-    "<figure>\n",
-    "<img src='images/open_terminal_window.jpg' height='30%' width='30%'/>\n",
-    "</figure>\n",
-    "\n",
-    "* Start a Voila session by running the command below in the terminal (just copy and paste it into the terminal):\n",
-    "\n",
-    "```bash\n",
-    "voila /home/xilinx/jupyter_notebooks/qpsk-demonstrator/voila_rfsoc_qpsk_demonstrator.ipynb --ExecutePreprocessor.timeout=180 --theme=dark --port=8866 --TagRemovePreprocessor.remove_cell_tags='{\"ignore_me\"}'\n",
-    "```\n",
-    "\n",
-    "* You can now open a new browser tab and enter the following into the address bar: http://board_ip_address:8866\n",
-    "\n",
-    "After you open the new tab at the address above, the kernel will start and the notebook will run. Only the QPSK demonstrator will be displayed. The initialisation process takes around 2 minutes.\n",
+    "After the new tab opens the kernel will start and the notebook will run. Only the QPSK Demonstrator will be displayed. The initialisation process takes around 1 minute.\n",
     "\n",
     "## The Voila Procedure <a class=\"anchor\" id=\"the-voila-procedure\"></a>\n",
     "Below are the code cells that will be ran when Voila is called. The procedure is fairly straight forward. Load the rfsoc-qpsk library, initialise the overlay, and display the QPSK demonstrator. All you have to ensure is that the above command is executed in the terminal and you have launched a browser tab using the given address. You do not need to run these code cells individually to create the voila dashboard.\n",
@@ -105,7 +119,22 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    }
+   },
    "outputs": [],
    "source": [
     "from rfsoc_qpsk.qpsk_overlay import QpskOverlay"
@@ -114,6 +143,20 @@
   {
    "cell_type": "markdown",
    "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    },
     "tags": [
      "ignore_me"
     ]
@@ -125,7 +168,22 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    }
+   },
    "outputs": [],
    "source": [
     "qpsk = QpskOverlay(dark_theme=True)"
@@ -134,6 +192,20 @@
   {
    "cell_type": "markdown",
    "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    },
     "tags": [
      "ignore_me"
     ]
@@ -145,7 +217,23 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": 0,
+        "height": 16,
+        "hidden": false,
+        "row": 0,
+        "width": 12
+       }
+      }
+     }
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "qpsk.qpsk_demonstrator_application()"
@@ -154,6 +242,20 @@
   {
    "cell_type": "markdown",
    "metadata": {
+    "extensions": {
+     "jupyter_dashboards": {
+      "activeView": "grid_default",
+      "views": {
+       "grid_default": {
+        "col": null,
+        "height": 2,
+        "hidden": true,
+        "row": null,
+        "width": 2
+       }
+      }
+     }
+    },
     "tags": [
      "ignore_me"
     ]
@@ -166,6 +268,21 @@
  ],
  "metadata": {
   "celltoolbar": "Tags",
+  "extensions": {
+   "jupyter_dashboards": {
+    "activeView": "grid_default",
+    "version": 1,
+    "views": {
+     "grid_default": {
+      "cellMargin": 2,
+      "defaultCellHeight": 60,
+      "maxColumns": 12,
+      "name": "grid",
+      "type": "grid"
+     }
+    }
+   }
+  },
   "kernelspec": {
    "display_name": "Python 3",
    "language": "python",
@@ -181,7 +298,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.8.2"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

diff --git a/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_jupyter_launcher.jpg b/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_jupyter_launcher.jpg
diff --git a/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_terminal_window.jpg b/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_terminal_window.jpg
diff --git a/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_voila.png b/boards/ZCU111/rfsoc_qpsk/notebooks/images/open_voila.png