User Guide

Contents

Set Up Environment Variables

Intel® Advisor
:
  • Provides the
    ADVISOR_<version>_DIR
    environment variable that you can use to specify additional include directories when compiling, so the compiler can find the
    Intel® Advisor
    include file that defines annotations.
    <version>
    is the Advisor year version (for example,
    2021
    ).
    To specify the environment variable:
    • On Windows* OS
      define the environment variable when you use the predefined command prompt or execute the environment script file.
    • On Linux* OS and MacOS*
      define the environment variable by using an
      export
      command.
  • Tests the
    ADVIXE_EXPERIMENTAL
    /
    ADVISOR_EXPERIMENTAL
    environment variable to determine whether evaluation features have been activated.
  • With C++ parallel
    Intel® oneAPI Threading Building Blocks (oneTBB)
    programs, the
    TBBROOT
    environment variable must be defined, so your compiler can locate the installed
    oneTBB
    include directory. See the help topic Defining the TBBROOT Environment Variable.
  • On Linux* OS and MacOS*
    Intel® Advisor
    uses the
    BROWSER
    environment variable on Linux* systems to locate an installed HTML browser. This enables the display of Getting Started Tutorials or Help from the
    Intel® Advisor
    GUI
    Help
    menu.
  • On Linux* OS and MacOS*
    , in addition to the
    File > Option> Editor
    settings, you can use the
    VISUAL
    or
    EDITOR
    environment variable to specify the external editor to launch when you double-click a line in a
    Source
    window. (
    VISUAL
    takes precedence over
    EDITOR
    ). For example, to set the
    VISUAL
    environment variable, use an
    export
    command:
    export VISUAL="/usr/bin/vi -n"
To view and set the
ADVISOR_<version>_DIR
environment variable:
Set Environment Variables
In the instructions below, be sure to replace any values in brackets, such as
<version>
or
<install-dir>
. The default installation path for the application,
<install-dir>
, can be found inside the following:
  • For Linux* OS and macOS*,
    <install-dir>
    is inside:
    • /opt/intel/oneapi/
      for root users
    • $HOME/intel/oneapi/
      for non-root users
  • For Windows* OS,
    <install-dir>
    is inside
    C:\Program Files (x86)\Intel\oneAPI\
    .
    For 32-bit systems, the
    Program files (x86)
    folder is
    Program files
    .
On Linux* OS / MacOS* via Script
  • For
    Intel Advisor
    as part of the
    Intel® oneAPI Base Toolkit
    , run one of the following shell scripts:
    source <install-dir>/setvars.sh
    source <install-dir>/setvars.csh
  • For
    Intel Advisor
    as standalone, run one of the following shell scripts:
    source <install-dir>/advisor/<version>/env/vars.sh
    source <install-dir>/advisor/<version>/env/vars.csh
    Replace
    <version>
    with
    latest
    to set up environment for the latest
    Intel Advisor
    version installed on your machine or a
    specific
    Intel Advisor
    version installed.
On Windows* OS via Script
  • For
    Intel Advisor
    as part of the
    Intel® oneAPI Base Toolkit
    , run the batch script:
    <install-dir>/setvars.bat
  • For
    Intel Advisor
    as standalone, run the batch script:
    source <install-dir>/advisor/<version>/env/vars.bat
    Replace
    <version>
    with
    latest
    to set up environment for the latest
    Intel Advisor
    version installed on your machine or a
    specific
    Intel Advisor
    version installed.
On Linux* OS / MacOS* Manually
  1. View the current definition of the environment variable. For example, with the
    bash
    shell, type:
    env | grep ADVISOR_<version>_DIR
  2. Use an
    export
    command to set the environment variable. Type:
    export ADVISOR_<version>_DIR="<install-dir>"
    For example, for the Intel Advisor 2021:
    export
    ADVISOR_2021_DIR
    ="
    /opt/intel/oneapi
    /advisor/latest"
  3. To always set this variable on the current system, add this definition to your
    .login
    or similar shell initialization file.
  4. To test the definition of an environment variable, type
    an
    export
    command.
On Windows* OS Manually
  1. Open a command line window.
  2. View the current definition of the environment variable. For example, type:
    set ADVISOR_<version>_DIR
  3. Use a
    set
    command to set the environment variable. Type:
    set ADVISOR_<version>_DIR="<install-dir>"
    For example, for the Intel Advisor 2021:
    set
    ADVISOR_2021_DIR
    ="
    C:\Program Files (x86)\Intel\oneAPI\
    advisor\latest"
  4. To always set this variable on the current system, add this definition to your system or user environment variables using
    Control Panel
    System and Security
    System
    Advanced system settings
    Environment Variables...
    .
Next Steps

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.