User Guide

  • 2020
  • 06/18/2020
  • Public Content
Contents

Setting and Using Intel® Advisor 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,
    2019
    for
    Intel® Advisor
    2019
    or
    2021
    for
    Intel® Advisor Beta
    ).
    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
    environment variable to determine whether evaluation features have been activated.
  • With C++ parallel
    Intel® Threading Building Blocks (Intel® TBB)
    programs, the
    TBBROOT
    environment variable must be defined, so your compiler can locate the installed
    Intel TBB
    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:
Setting 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,
    <install-dir>
    is inside:
    • /opt/intel/
      for root users
    • $HOME/intel/
      for non-root users
    For example,
    <install-dir>
    may be
    /opt/intel/advisor_2019
    for
    Intel Advisor
    2019
    or
    /opt/intel/inteloneapi
    /advisor/<version>
    for
    Intel® Advisor Beta
    .
  • For Windows* OS,
    <install-dir>
    is inside:
    • C:\Program Files (x86)\IntelSWTools\
      for
      Intel Advisor
      .
    • C:\Program Files (x86)\inteloneapi\
      for
      Intel® Advisor Beta
      .
    For 32-bit systems, the
    Program files (x86)
    folder is
    Program files
    .
    For example,
    <install-dir>
    may be
    C:\Program Files (x86)\IntelSWTools\
    Advisor 2019
    for
    Intel® Advisor
    2019
    or
    C:\Program Files (x86)\inteloneapi\
    advisor\<version>
    for
    Intel® Advisor Beta
    .
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:
    export ADVISOR_2019_DIR="/opt/intel/advisor_2019"
    for
    Intel Advisor
    2019
    or
    export
    ADVISOR_2021_DIR
    ="
    /opt/intel/inteloneapi
    /advisor/<version>"
    for
    Intel® Advisor Beta
  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 Linux* OS / MacOS* via Script
Run the shell script, as follows:
  • For
    Intel Advisor
    :
    source <install-dir>/advixe-vars.sh
    or
    source <install-dir>/advixe-vars.csh
  • For
    Intel® Advisor Beta
    :
    source <install-dir>/env/vars.sh
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:
    set ADVISOR_2019_DIR="C:\Program files (x86)\IntelSWTools\Advisor 2019"
    or
    set
    ADVISOR_2021_DIR
    ="
    C:\Program Files (x86)\inteloneapi\
    advisor\<version>"
    (for
    Intel® Advisor Beta
    )
  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...
    .
On Windows* OS via Script
Run the batch script, as follows:
  • <install-dir>/advixe-vars.bat
  • <install-dir>/env/vars.bat
    (for
    Intel® Advisor Beta
    )

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804