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

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

3.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 Linux 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 3.   Intel® FPGA RTE for OpenCL™ Linux User Environment Variable Settings
Environment Variable Path to Include
PATH $INTELFPGAOCLSDKROOT/bin

where INTELFPGAOCLSDKROOT points to the path of the software installation

LD_LIBRARY_PATH $INTELFPGAOCLSDKROOT/host/linux64/lib

$AOCL_BOARD_PACKAGE_ROOT/linux64/lib

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

  • To apply permanent environment variable settings, open a shell and then type the export <variable_name>="<variable_setting>":$<variable_name> command.
    For example, the command export PATH="$INTELFPGAOCLSDKROOT/bin":$PATH adds $INTELFPGAOCLSDKROOT/bin to the list of PATH settings.
  • To apply transient environment variable settings, open a bash-shell command-line terminal and run the source $INTELFPGAOCLSDKROOT/init_opencl.sh command. This command does not work in other shells.

    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
    Adding $INTELFPGAOCLSDKROOT/bin to PATH
    Adding $INTELFPGAOCLSDKROOT/host/linux64/lib to LD_LIBRARY_PATH
    Adding $AOCL_BOARD_PACKAGE_ROOT/linux64/lib to LD_LIBRARY_PATH

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