Enabling the Vitis API to be used in a Python ENV - 2025.2 English - UG1400

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)
Document ID
UG1400
Release Date
2025-11-20
Version
2025.2 English

Enabling the Vitis API in you user Python environment allows you to run a generic Python script within the Vitis tool.

Linux

Open a linux command prompt and execute the following commands:

export XILINX_VITIS=<LOCAL_VITIS_INSTALLATION_DIRECTIRY>/2025.2/Vitis
source <LOCAL_VITIS_INSTALLATION_DIRECTIRY>/2025.2/Vitis/cli/examples/customer_python_utils/setup_vitis_env.sh
Run Python in the command prompt with the following command:
$VITIS_INSTALL_PATH/2025.2/Vitis/tps/lnx64/python-3.13.0/bin/python
or Launch your local python using 
./python
Execute the following Python commands:
import vitis
client = vitis.create_client()
client.get_template()
Figure 1. Python Script

To run a Python script, execute the following command:
&VITIS_INSTALL_PATH/2025.2/Vitis/tps/lnx64/python-3.13.0/bin/python -s sample_testcase.py

Windows

On Windows, open a windows command prompt and execute the following commands:

set XILINX_VITIS=<LOCAL_VITIS_INSTALLATION_DIRECTORY>\2025.2\Vitis

<LOCAL_VITIS_INSTALLATION_DIRECTORY>\2025.2\Vitis\cli\examples\customer_python_utils>setup_vitis_env.bat

To run a Python script in the command prompt, execute the following command:

<vitis_install_dir>\2025.2\Vitis\tps\win64\python-3.13.0\python.exe
To run a Python script, execute the following command:
<vitis_install_dir>\2025.2\Vitis\tps\win64\python-3.13.0\python.exe -s sample_testcase.py