Intel® FPGA RTE for OpenCL™ Standard Edition: Getting Started Guide

ID 683550
Date 9/24/2018
Public
Document Table of Contents

2.3. Setting the Intel® FPGA RTE for OpenCL™ Standard Edition User Environment Variables

You have the option to set the Intel® FPGA RTE for OpenCL™ Standard Edition Windows user environment variables permanently or transiently. The environment variable settings describe the FPGA board and the host runtime to the software.
Attention: If you set the environment variables permanently, you apply the settings once during installation. If you set the environment variables transiently, you must apply the settings during installation and during every subsequent session you run.
Table 2.   Intel® FPGA RTE for OpenCL™ Windows User Environment Variable Settings
Environment Variable Path to Include
PATH
  1. %INTELFPGAOCLSDKROOT%\bin
  2. %INTELFPGAOCLSDKROOT%\windows64\bin
  3. %INTELFPGAOCLSDKROOT%\host\windows64\bin

where INTELFPGAOCLSDKROOT points to the path of the software installation

  • To apply permanent environment variable settings, perform the following tasks:
    1. Click Windows Start menu > Control Panel (or search for and then open the Control Panel application in Windows 8.1 and Windows 10).
    2. Click System and Security > System.
    3. In the System window, click Advanced system settings.
    4. Click the Advanced tab in the System Properties dialog box.
    5. Click Environment Variables.
      The Environment Variables dialog box appears.
    6. To modify an existing environment variable setting, select the variable under User variables for <user_name> and then click Edit. In the Edit User Variable dialog box, type the environment variable setting in the Variable value field.
    7. If you add a new environment variable, click New under User variables for <user_name>. In the New User Variable dialog box, type the environment variable name and setting in the Variable name and Variable value fields, respectively.

    For an environment variable with multiple settings, add semicolons to separate the settings.

  • To apply transient environment variable settings, open a command window and run the %INTELFPGAOCLSDKROOT%\init_opencl.bat script.

    Example script output:

    AOCL_BOARD_PACKAGE_ROOT path is not set in environment
    Setting to default s5_ref board.
    If you want to target another board, do
      set AOCL_BOARD_PACKAGE_ROOT=board_pkg_dir
    and re-run this script
    Adding %INTELFPGAOCLSDKROOT%\bin to PATH
    Adding %INTELFPGAOCLSDKROOT%\host\windows64\bin to PATH
    Adding %AOCL_BOARD_PACKAGE_ROOT%\windows64\bin to PATH

    where AOCL_BOARD_PACKAGE_ROOT points to the path of the Custom or Reference Platform.

    Running the init_opencl.bat script only affects the current command window. The script performs the following tasks:
    • Finds the Microsoft Visual Studio installation
    • Imports the Microsoft Visual Studio environment to properly set the LIB environment variable
    • Ensures that the PATH environment variable includes the path to the Microsoft LINK.EXE file and the aocl.exe file