Using Local Copies - 2021.1 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
UG1393
Release Date
2022-03-29
Version
2021.1 English

While you must download the examples to add templates when you create new projects, the Vitis IDE always downloads the examples into your local .Xilinx/vitis/<version> folder:

  • On Windows: C:\Users\<user_name>\.Xilinx\vitis\<version>
  • On Linux: ~/.Xilinx/vitis/<version>

The download directory cannot be changed from the Vitis IDE Examples dialog box. You might want to download the example files to a different location from the .Xilinx folder. To perform this, use the git command from a command shell to specify a new destination folder for the downloaded examples:

git clone https://github.com/Xilinx/Vitis_Examples 
<workspace>/examples

When you clone the examples using the git command as shown above, you can use the example files as a resource for application and kernel code to use in your own projects. However, many of the files use include statements to include other example files that are managed in the makefiles of the various examples. These include files are automatically populated into the src folder of a project when the template is added through the New Vitis Project wizard. To make the files local, locate the files and manually make them local to your project.

You can find the needed files by searching for the file from the location of the cloned repository. For example, you can run the following command from the examples folder to find the xcl2.hpp file needed for the vadd example.

find -name xcl2.hpp