Vitis™ Application Acceleration Development Flow Tutorials

Vitis Getting Started Tutorial

Part 2 : Installation and Configuration

To develop and deploy applications with Vitis, you need to install the Vitis unified software environment, the Xilinx Runtime library (XRT) and the platform files specific to the acceleration card used in your project.

Step 1 – Review the Installation Requirements

Prior to starting the installation process, make sure to check the Vitis installation requirements.

NOTE: Windows OS support is limited to the Vitis embedded software development flow. The Vitis application acceleration flow is only supported on Linux.

Step 2 – Download Vitis

Download the latest version of the Vitis from the Xilinx download website. Make sure to download the Linux Self-Extracting web installer or the Single-File installer.

Step 3 – Install Downloaded Packages

After downloading the Vitis, XRT and platform packages, install them in the following order and according to the provided instructions:

  1. Install the Vitis Software Platform

  2. Install the Xilinx Runtime and Platforms

Note: Installing XRT is not required when targeting Arm-based embedded platforms. The Vitis compiler has its own copy of xclbinutil for hardware generation; and for software compilation you can use the XRT from the sysroot on the Embedded Processor platform.

Step 4 – Download and Install the Required Platform files

Step 4A - Installing Data Center Platform Files

Xilinx provides base platforms for the Alveo U200, U250, U50 and U280 data-center acceleration cards. Before installing a platform, you need to download the following packages:

  1. Xilinx Runtime (XRT)

  2. Deployment Target Platform

  3. Development Target Platform

The packages required for each platform can be found on the corresponding download pages:

Step 4B - Installing Embedded Processor Platform Files

Xilinx provides base platforms for the ZCU102 and ZCU104 cards. Before installing a platform, you need to download the following packages:

  1. Base platform

  2. Common image

The packages required for each platform can be found on the corresponding download pages:

Step 5 – Setup the environment to run Vitis

To configure the environment to run Vitis, run the following script which sets up the environment to run in a specific command shell.

source <Vitis_install_path>/Vitis/2022.1/settings64.sh

NOTE: .csh scripts are also provided but this tutorial assumes a bash shell is used.

To configure XRT for Alveo Data Center accelerator cards run the following script. This is not required for Embedded platforms.

source /opt/xilinx/xrt/setup.sh

To specify the location of any Data-Center or Embedded platforms you have installed, set the following environment variable:

export PLATFORM_REPO_PATHS=<path to platforms>

NOTE: On some Ubuntu distributions, you must also export the LIBRARY_PATH to properly set up Vitis.

export LIBRARY_PATH=/usr/lib/x86_64-linux-gnu

For more information see Xilinx AR 73698.

Next Step

Click here to Review the Host and Kernel Code


License statement

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright© 2020–2022 Xilinx