Jupyter Notebook Support - 2023.1 English

Vitis Unified IDE and Common Command-Line Reference Manual (UG1553)

Document ID
UG1553
Release Date
2023-07-17
Version
2023.1 English
The Jupyter Notebook is a web application for creating and sharing computational documents. It offers a simple, streamlined, document-centric experience. Your code in Jupyter Notebook can produce rich, interactive output: HTML, images, videos, LaTeX, and custom MIME types. The new Vitis IDE integration with Jupyter Notebook allows you to access the Vitis environment remotely, iterate host code rapidly, tune acceleration kernel code and view the interactive output in one environment.

You can use Vitis server commands in this environment to manipulate components and System projects. To launch Jupyter Notebook server, run the following commands:

  1. vitis -new -j
  2. The Jupyter Notebook server will launch and it will open your default browser to open the web UI.
  3. To pass additional options to Jupyter Notebook server, you can append these options. For example, vitis -j --ip=<ip_address> specifies the IP address the notebook server will listen on.
Figure 1. Jupyter Notebook

To close the Jupyter Notebook server, press Ctrl +C in the console where you launch it. It will stop the server and shut down all kernels. Pressing Ctrl + C twice would skip confirmation.