Setting and Using Intel® Advisor
Environment Variables
Setting and Using Intel® Advisor
Environment Variables
Intel® Advisor
- Provides theADVISOR_<version>_DIRenvironment variable that you can use to specify additional include directories when compiling, so the compiler can find theinclude file that defines annotations.Intel® Advisor<version>is the Advisor year version (for example,2019forIntel® Advisor2019or).2021forIntel® Advisor BetaTo specify the environment variable:
- On Windows* OSdefine 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 anexportcommand.
- Tests theenvironment variable to determine whether evaluation features have been activated.ADVIXE_EXPERIMENTAL
- With C++ parallelIntel® Threading Building Blocks (Intel® TBB)programs, theTBBROOTenvironment variable must be defined, so your compiler can locate the installedIntel TBBinclude directory. See the help topic Defining the TBBROOT Environment Variable.
- On Linux* OS and MacOS*uses theIntel® AdvisorBROWSERenvironment variable on Linux* systems to locate an installed HTML browser. This enables the display of Getting Started Tutorials or Help from theGUIIntel® AdvisorHelpmenu.
- On Linux* OS and MacOS*, in addition to theFile > Option> Editorsettings, you can use theVISUALorEDITORenvironment variable to specify the external editor to launch when you double-click a line in aSourcewindow. (VISUALtakes precedence overEDITOR). For example, to set theVISUALenvironment variable, use anexportcommand: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 and macOS*,<install-dir>is inside:
- /opt/intel/or/opt/intel/oneapi/(Intel® Advisor Beta) for root users
- $HOME/intel/or$HOME/intel/oneapi/(Intel® Advisor Beta) for non-root users
For example,<install-dir>may be/opt/intel/advisor_2019forIntel Advisor2019or./opt/intel/oneapi/advisor/<version>forIntel® Advisor Beta - For Windows* OS,<install-dir>is inside:
- forC:\Program Files (x86)\IntelSWTools\Intel Advisor.
- forC:\Program Files (x86)\Intel\oneAPI\Intel® Advisor Beta.
For 32-bit systems, theProgram files (x86)folder isProgram files.For example,<install-dir>may beC:\Program Files (x86)\IntelSWTools\Advisor 2019forIntel® Advisor2019or.C:\Program Files (x86)\Intel\oneAPI\advisor\<version>forIntel® Advisor Beta
On Linux* OS / MacOS* Manually
- View the current definition of the environment variable. For example, with thebashshell, type:env | grep ADVISOR_<version>_DIR
- Use anexportcommand to set the environment variable. Type:export ADVISOR_<version>_DIR="<install-dir>"For example:export ADVISOR_2019_DIR="/opt/intel/advisor_2019"forIntel Advisor2019orexportfor="ADVISOR_2021_DIR/advisor/<version>"/opt/intel/oneapiIntel® Advisor Beta
- To always set this variable on the current system, add this definition to your.loginor similar shell initialization file.
- To test the definition of an environment variable, typeanexportcommand.
On Linux* OS / MacOS* via Script
Run the shell script, as follows:
- ForIntel Advisor:source <install-dir>/advixe-vars.shorsource <install-dir>/advixe-vars.csh
- ForIntel® Advisor Beta:source <install-dir>/.shenv/vars
On Windows* OS Manually
- Open a command line window.
- View the current definition of the environment variable. For example, type:set ADVISOR_<version>_DIR
- Use asetcommand 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"orset(for="ADVISOR_2021_DIRadvisor\<version>"C:\Program Files (x86)\Intel\oneAPI\Intel® Advisor Beta)
- To always set this variable on the current system, add this definition to your system or user environment variables using.
On Windows* OS via Script
Run the batch script, as follows:
- <install-dir>/advixe-vars.bat
- <install-dir>/env/vars.bat(forIntel® Advisor Beta)