Vitis Software Platform Installation

For hardware-accelerated application development, do the following: install the Vitis™ tools, Xilinx Runtime (XRT), and applicable platform files, as outlined below:

  1. Install the Vitis Software Platform
  2. Follow the instructions in Installing Xilinx Runtime.
  3. Install the embedded platform, as described in Installing Embedded Platforms
  4. Install the data center platform, as described in Installing Data Center Platforms
  5. Follow the instructions in Setting Up the Environment to Run the Vitis Software Platform.
Note: To install and use XRT on CentOS/RedHat, ensure that you have already installed all required packages and recommended libraries, as described in Install Required CentOS/RHEL Packages.

Install the Vitis Software Platform

Ensure your system meets all requirements described in Installation Requirements.
TIP: To reduce installation time, disable anti-virus software and close all open programs that are not needed.
  1. Go to the Xilinx Downloads Website.
  2. Download the installer for your operating system.
  3. Run the installer, which opens the Xilinx Unified 2019.2 Installer.
  4. Click Next.
  5. Enter your Xilinx user account credentials, and then select Download and Install Now.
  6. Click Next.
  7. Accept the terms and conditions by clicking each I Agree check box.
  8. Click Next.
  9. Select Vitis, and then click Next.
  10. Customize your installation by selecting design tools and devices, and then click Next.
    IMPORTANT: Do not deselect the following options. They are required for installation.
    • Devices > Install devices for Alveo and Xilinx Edge acceleration platforms
    • Devices for Custom Platforms > 7 Series > Virtex-7
    Note: By default, both the Vitis tools and Vivado Design Suite are installed. You do not need to separately install Vivado tools. You can also install System Generator and Model Composer if needed.
  11. Select the installation directory, optional shortcut and file association options, and then click Next.
  12. Review the installation summary, which shows the options and locations you have selected.
  13. To proceed with the installation of the Vitis software platform, click Install.

After a successful installation, a confirmation message is displayed.

IMPORTANT: If you are installing the Vitis tools on a network system that remote users will be accessing, you must also enable user permissions for specific files in the installation. Enter the following commands from the Vitis installation directory:
chmod -R o=g <install_dir>/Vitis/2019.2/tps/lnx64/jre9.0.4
chmod -R o=g <install_dir>/Vivado/2019.2/tps/lnx64/jre9.0.4
chmod -R o=g <install_dir>/.xinstall/Vitis_2019.2/tps/lnx64/jre9.0.4

If the software was installed with sudo privileges, you must use sudo for the preceding commands.

Installing Xilinx Runtime

Xilinx Runtime (XRT) is implemented as a combination of user-space and kernel driver components. XRT supports Alveo PCIe-based cards, as well as Zynq UltraScale+ MPSoC-based embedded system platforms, and provides a software interface to Xilinx programmable logic devices.

You only need to install XRT once, regardless of how many platforms you may be installing.

IMPORTANT: XRT installation uses standard Linux RPM and Linux DEB distribution files, and root access is required for all software and firmware installations.

<rpm-dir> or <deb-dir> is the directory where you downloaded the packages to install.

To download and install the XRT package for your operating system, do the following.

CentOS/RedHat

  1. To download the RPM file, click this link.
  2. To install the package, enter the following command.
    sudo yum install <rpm-dir>/<xrt_filename>.rpm

Ubuntu

  1. To download the DEB file, click one of the following: .
  2. To install the package, enter the following command.
    sudo apt install <deb-dir>/<xrt_filename_OS>.deb
    Note: <OS> represents the Ubuntu operating system version (16.04 or 18.04) you are using.
    IMPORTANT: When installing XRT on Ubuntu, if the 2015 version of pyopencl is installed on your system, you must uninstall it. The XRT installation will install the 2019 version of pyopencl and will return an error if the 2015 version is installed. For more information, see AR#73055.

Installing Data Center Platforms

For data center applications, you can configure your system for developing and debugging applications using the Vitis development environment, as well as running them on hardware. This does not require the actual accelerator card, but does require the installation of XRT, the deployment platform, and the development platform for each accelerator card you plan to develop applications for.
TIP: While the system does not require an accelerator card to develop applications, it is required to run and debug the application on hardware.

The platform includes information necessary for compiling and debugging new acceleration applications. It is a required part of the Vitis environment to support a specific accelerator card in the tool. Each accelerator card requires a platform that must be installed to support that platform in the Vitis environment.

Note: You must resolve any code host library dependencies.

Install Platforms on CentOS/RedHat

If you are installing these packages for use with the Vitis development environment and do not have an installed card, then you can ignore any message asking you to flash the accelerator card. However, if you are installing these packages for use with an installed accelerator card, you must follow the instructions in Getting Started with Alveo Data Center Accelerator Cards (UG1301).
IMPORTANT: Before installing platforms, you must have Xilinx Runtime installed, as described in Installing Xilinx Runtime.
  1. Download the deployment and development target platform packages for the Alveo Data Center Accelerator card you are using:
    U50
    Deployment Target Platform and Development Target Platform
    U200
    Deployment Target Platform and Development Target Platform
    U250
    Deployment Target Platform and Development Target Platform
    U280
    Deployment Target Platform and Development Target Platform
  2. To install the packages, enter the following command.
    sudo yum install <rpm-dir>/<deployment_shell_filename>.rpm
    sudo yum install <rpm-dir>/<development_shell_filename>.rpm
    Note: <rpm-dir> is the directory where you downloaded the packages to install.

Install Platforms on Ubuntu

If you are installing these packages for use with the Vitis development environment and do not have an installed card, then you can ignore any message asking you to flash the accelerator card. However, if you are installing these packages for use with an installed accelerator card, you must follow the instructions in Getting Started with Alveo Data Center Accelerator Cards (UG1301).
IMPORTANT: Before installing platforms, you must have Xilinx Runtime installed, as described in Installing Xilinx Runtime.
  1. Download the deployment and development target platform packages for the Alveo Data Center Accelerator card you are using:
    U50
    Ubuntu 16.04
    Deployment Target Platform and Development Target Platform
    Ubuntu 18.04
    Deployment Target Platform and Development Target Platform
    U200
    Ubuntu 16.04
    Deployment Target Platform and Development Target Platform
    Ubuntu 18.04
    Deployment Target Platform and Development Target Platform
    U250
    Ubuntu 16.04
    Deployment Target Platform and Development Target Platform
    Ubuntu 18.04
    Deployment Target Platform and Development Target Platform
    U280
    Ubuntu 16.04
    Deployment Target Platform and Development Target Platform
    Ubuntu 18.04
    Deployment Target Platform and Development Target Platform
  2. To install the packages, enter the following command.
    sudo apt install <deb-dir>/<deployment_shell_filename_OS>.deb
    sudo apt install <deb-dir>/<development_shell_filename_OS>.deb
    Note: <deb-dir> is the directory where you downloaded the packages to install. <OS> represents the Ubuntu operating system version (16.04 or 18.04) you are using.

Installing Embedded Platforms

IMPORTANT: Embedded platforms require the installation of XRT, as described in Installing Xilinx Runtime.

Embedded targets must run Linux and XRT to support the Vitis application acceleration development flow. You can also use embedded platforms with standalone/bare metal or RTOS domains for the Vitis embedded software development flow. The embedded processor platforms can be found at https://developer.xilinx.com/.

The embedded platforms currently supported by XRT include the platforms listed below. These platforms are available for use with the Vitis tools in embedded processor applications but must be separately installed and configured.

zcu102_base.zip
Provides the platform definition, XRT drivers, and shared libraries for the zcu102_base platform.
zcu104_base.zip
Provides the platform definition, XRT drivers, and shared libraries for the zcu104_base platform.
zc702_base.zip
Provides the platform definition, XRT drivers, and shared libraries for the zc702_base platform.
zc706_base.zip
Provides the platform definition, XRT drivers, and shared libraries for the zc706_base platform.
sdk.sh
Sets up the sysroot headers, libs, and include files for compilation of applications running on the embedded platforms. This setup script must be run to configure the Vitis application for use with these platforms.
IMPORTANT: Embedded platforms are configured without <SYSROOT> in the platform, so you must set this environment variable before you launch the Vitis tools.

For example, point <SYSROOT> to /path/to/aarch64-xilinx-linux, which is the output generated after running sdk.sh.

To make the embedded platforms available to the Vitis tools, extract the archive into the <VITIS_INSTALL_DIR>/platforms directory (where you installed the Vitis tools), which is where the tool automatically looks for platforms.

Setting Up the Environment to Run the Vitis Software Platform

To configure the environment to run the Vitis software platform, set up the environment to run in a specific command shell by running the following scripts: source the files below so that the Vitis tools and Xilinx Runtime are in the PATH.

To configure the environment to run the Vitis software platform, run the following scripts, which set up the environment to run in a specific command shell.

 #setup XILINX_VITIS and XILINX_VIVADO variables
 source <Vitis_install_path>/settings64.sh
 #setup XILINX_XRT
 source /opt/xilinx/xrt/setup.sh
TIP: .csh scripts are also provided.
To specify the location of any platforms you have installed as directed in Installing Data Center Platforms, or Installing Embedded Platforms, set the following environment variable:
export PLATFORM_REPO_PATHS=<path to platforms>

Windows

To launch the Vitis software platform from Windows, do one of the following:

  • Launch from a desktop icon or Start menu command.
  • From a Windows command shell, use settings64.bat:
    C:> <VITIS_INSTALL_DIR>\VITIS\2019.2\settings64.bat

    And launch: vitis.