|
3 | 3 | { |
4 | 4 | "cell_type": "markdown", |
5 | 5 | "metadata": { |
| 6 | + "extensions": { |
| 7 | + "jupyter_dashboards": { |
| 8 | + "activeView": "grid_default", |
| 9 | + "views": { |
| 10 | + "grid_default": { |
| 11 | + "col": null, |
| 12 | + "height": 2, |
| 13 | + "hidden": true, |
| 14 | + "row": null, |
| 15 | + "width": 2 |
| 16 | + } |
| 17 | + } |
| 18 | + } |
| 19 | + }, |
6 | 20 | "tags": [ |
7 | 21 | "ignore_me" |
8 | 22 | ] |
|
14 | 28 | { |
15 | 29 | "cell_type": "markdown", |
16 | 30 | "metadata": { |
| 31 | + "extensions": { |
| 32 | + "jupyter_dashboards": { |
| 33 | + "activeView": "grid_default", |
| 34 | + "views": { |
| 35 | + "grid_default": { |
| 36 | + "col": null, |
| 37 | + "height": 2, |
| 38 | + "hidden": true, |
| 39 | + "row": null, |
| 40 | + "width": 2 |
| 41 | + } |
| 42 | + } |
| 43 | + } |
| 44 | + }, |
17 | 45 | "tags": [ |
18 | 46 | "ignore_me" |
19 | 47 | ] |
|
74 | 102 | "## Running this Demonstration <a class=\"anchor\" id=\"running-this-demonstration\"></a>\n", |
75 | 103 | "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", |
76 | 104 | "\n", |
77 | | - "* Open the Jupyter Quick Launch window as below:\n", |
| 105 | + "* Click on the \"Open with Voila Gridstack in a new browser tab\" button at the top of the screen:\n", |
78 | 106 | "\n", |
79 | 107 | "<figure>\n", |
80 | | - "<img src='images/open_jupyter_launcher.jpg' height='25%' width='25%'/>\n", |
| 108 | + "<img src='images/open_voila.png' height='50%' width='50%'/>\n", |
81 | 109 | "</figure>\n", |
82 | 110 | "\n", |
83 | | - "* Open a terminal window.\n", |
84 | | - "\n", |
85 | | - "<figure>\n", |
86 | | - "<img src='images/open_terminal_window.jpg' height='30%' width='30%'/>\n", |
87 | | - "</figure>\n", |
88 | | - "\n", |
89 | | - "* Start a Voila session by running the command below in the terminal (just copy and paste it into the terminal):\n", |
90 | | - "\n", |
91 | | - "```bash\n", |
92 | | - "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", |
93 | | - "```\n", |
94 | | - "\n", |
95 | | - "* You can now open a new browser tab and enter the following into the address bar: http://board_ip_address:8866\n", |
96 | | - "\n", |
97 | | - "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", |
| 111 | + "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", |
98 | 112 | "\n", |
99 | 113 | "## The Voila Procedure <a class=\"anchor\" id=\"the-voila-procedure\"></a>\n", |
100 | 114 | "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 | 119 | { |
106 | 120 | "cell_type": "code", |
107 | 121 | "execution_count": null, |
108 | | - "metadata": {}, |
| 122 | + "metadata": { |
| 123 | + "extensions": { |
| 124 | + "jupyter_dashboards": { |
| 125 | + "activeView": "grid_default", |
| 126 | + "views": { |
| 127 | + "grid_default": { |
| 128 | + "col": null, |
| 129 | + "height": 2, |
| 130 | + "hidden": true, |
| 131 | + "row": null, |
| 132 | + "width": 2 |
| 133 | + } |
| 134 | + } |
| 135 | + } |
| 136 | + } |
| 137 | + }, |
109 | 138 | "outputs": [], |
110 | 139 | "source": [ |
111 | 140 | "from rfsoc_qpsk.qpsk_overlay import QpskOverlay" |
|
114 | 143 | { |
115 | 144 | "cell_type": "markdown", |
116 | 145 | "metadata": { |
| 146 | + "extensions": { |
| 147 | + "jupyter_dashboards": { |
| 148 | + "activeView": "grid_default", |
| 149 | + "views": { |
| 150 | + "grid_default": { |
| 151 | + "col": null, |
| 152 | + "height": 2, |
| 153 | + "hidden": true, |
| 154 | + "row": null, |
| 155 | + "width": 2 |
| 156 | + } |
| 157 | + } |
| 158 | + } |
| 159 | + }, |
117 | 160 | "tags": [ |
118 | 161 | "ignore_me" |
119 | 162 | ] |
|
125 | 168 | { |
126 | 169 | "cell_type": "code", |
127 | 170 | "execution_count": null, |
128 | | - "metadata": {}, |
| 171 | + "metadata": { |
| 172 | + "extensions": { |
| 173 | + "jupyter_dashboards": { |
| 174 | + "activeView": "grid_default", |
| 175 | + "views": { |
| 176 | + "grid_default": { |
| 177 | + "col": null, |
| 178 | + "height": 2, |
| 179 | + "hidden": true, |
| 180 | + "row": null, |
| 181 | + "width": 2 |
| 182 | + } |
| 183 | + } |
| 184 | + } |
| 185 | + } |
| 186 | + }, |
129 | 187 | "outputs": [], |
130 | 188 | "source": [ |
131 | 189 | "qpsk = QpskOverlay(dark_theme=True)" |
|
134 | 192 | { |
135 | 193 | "cell_type": "markdown", |
136 | 194 | "metadata": { |
| 195 | + "extensions": { |
| 196 | + "jupyter_dashboards": { |
| 197 | + "activeView": "grid_default", |
| 198 | + "views": { |
| 199 | + "grid_default": { |
| 200 | + "col": null, |
| 201 | + "height": 2, |
| 202 | + "hidden": true, |
| 203 | + "row": null, |
| 204 | + "width": 2 |
| 205 | + } |
| 206 | + } |
| 207 | + } |
| 208 | + }, |
137 | 209 | "tags": [ |
138 | 210 | "ignore_me" |
139 | 211 | ] |
|
145 | 217 | { |
146 | 218 | "cell_type": "code", |
147 | 219 | "execution_count": null, |
148 | | - "metadata": {}, |
| 220 | + "metadata": { |
| 221 | + "extensions": { |
| 222 | + "jupyter_dashboards": { |
| 223 | + "activeView": "grid_default", |
| 224 | + "views": { |
| 225 | + "grid_default": { |
| 226 | + "col": 0, |
| 227 | + "height": 16, |
| 228 | + "hidden": false, |
| 229 | + "row": 0, |
| 230 | + "width": 12 |
| 231 | + } |
| 232 | + } |
| 233 | + } |
| 234 | + }, |
| 235 | + "tags": [] |
| 236 | + }, |
149 | 237 | "outputs": [], |
150 | 238 | "source": [ |
151 | 239 | "qpsk.qpsk_demonstrator_application()" |
|
154 | 242 | { |
155 | 243 | "cell_type": "markdown", |
156 | 244 | "metadata": { |
| 245 | + "extensions": { |
| 246 | + "jupyter_dashboards": { |
| 247 | + "activeView": "grid_default", |
| 248 | + "views": { |
| 249 | + "grid_default": { |
| 250 | + "col": null, |
| 251 | + "height": 2, |
| 252 | + "hidden": true, |
| 253 | + "row": null, |
| 254 | + "width": 2 |
| 255 | + } |
| 256 | + } |
| 257 | + } |
| 258 | + }, |
157 | 259 | "tags": [ |
158 | 260 | "ignore_me" |
159 | 261 | ] |
|
166 | 268 | ], |
167 | 269 | "metadata": { |
168 | 270 | "celltoolbar": "Tags", |
| 271 | + "extensions": { |
| 272 | + "jupyter_dashboards": { |
| 273 | + "activeView": "grid_default", |
| 274 | + "version": 1, |
| 275 | + "views": { |
| 276 | + "grid_default": { |
| 277 | + "cellMargin": 2, |
| 278 | + "defaultCellHeight": 60, |
| 279 | + "maxColumns": 12, |
| 280 | + "name": "grid", |
| 281 | + "type": "grid" |
| 282 | + } |
| 283 | + } |
| 284 | + } |
| 285 | + }, |
169 | 286 | "kernelspec": { |
170 | 287 | "display_name": "Python 3", |
171 | 288 | "language": "python", |
|
181 | 298 | "name": "python", |
182 | 299 | "nbconvert_exporter": "python", |
183 | 300 | "pygments_lexer": "ipython3", |
184 | | - "version": "3.6.5" |
| 301 | + "version": "3.8.2" |
185 | 302 | }, |
186 | 303 | "widgets": { |
187 | 304 | "application/vnd.jupyter.widget-state+json": { |
|
0 commit comments