Setting Up the Vitis Tool Environment - 2025.2 English - UG1076

AI Engine Tools and Flows User Guide (UG1076)

Document ID
UG1076
Release Date
2025-11-20
Version
2025.2 English

The AI Engine tools are delivered and installed as part of the Vitis unified software platform. You must therefore set up the Vitis unified software platform before running the AI Engine tools (for example the compiler and simulator). The AMD Vitis™ unified software includes embedded base platforms targeting select boards like the VCK190 and the VEK280. You can also download the Common Images for Embedded AMD Vitis™ Platforms from https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/embedded-platforms.html. The common image package contains a prebuilt Linux kernel and root file system that can be used with the AMD Versal™ device evaluation board for embedded design development together with the appropriate Vitis base platform.

For more information, see Vitis Software Platform Release Notes in the Vitis Software Platform Release Notes (UG1742).

Run the following script after installing the AMD Vitis™ unified software platform. This script sets the necessary environment variables such as XILINX_VITIS and XILINX_HLS.

source <Vitis_install_path>/Vitis/<version>/settings64.csh
Tip: The settings64.sh for the Bash shell is also provided in the same directory.

Set up your PLATFORM_REPO_PATHS environment variable to $XILINX_VITIS/base_platforms

setenv PLATFORM_REPO_PATHS $XILINX_VITIS/base_platforms
Tip: The PLATFORM_REPO_PATHS environment variable points to directories containing platform files (XPFM). This lets you specify platforms using only the folder name for the platform.

The AI Engine tools require a license. You can generate a free license for the AI Engine tools from any eligible AMD licensing account. Set the path to the license in one of the following environment variables: XILINXD_LICENSE_FILE or LM_LICENSE_FILE.

You can validate the installation and setup of the tools by using one of the following commands.

vitis --help