User Guide

Contents

Command Option Reference

This reference section describes the command line options available for each of the Offload Advisor Python* scripts.
To use the Offload Advisor, run one or two of the following scripts, depending on a method you chose:

Command Syntax

The syntax for Offload Advisor commands is as follows:
advixe-python <APM>/<script-name>.py <project-dir> [--options] [-- <target> [target-options]]
where:
advixe-python
A call to the Intel Advisor Python* command line tool.
advixe-python
is recommended to run the Offload Advisor Python scripts. The main advantage of using this command line tool is that it does not require you to install a specific Python version on your system because it calls to an internal Python version of the Intel Advisor.
<APM>
The environment variable that points to the directory with the Intel® Advisor Beta scripts. Replace it with:
  • $APM
    on Linux* OS
  • %APM%
    on Windows* OS
<script-name>
A script name to run:
run_oa.py
,
collect.py
, or
analyze.py
.
<project-dir>
The path to a Intel® Advisor Beta project directory.
<--options>
Options to modify behavior specific to the script. You can specify several options per script. Using an option not supported by the script causes a usage error.
<target>
A target application to analyze.
You do not need to specify a target executable and target options when running the
analyze.py
script.
[target-options]
Options to modify target application behavior.

Syntax Rules and Alternatives

  • An option can be preceded by one or two dashes. This section uses two dashes before long version of options and one dash before short version of options. For example, the following commands are equivalent:
    advixe-python $APM/run_oa.py -h
    advixe-python $APM/run_oa.py --help
  • The path to a project directory must always follow after a script name. For example:
    advixe-python $APM/analyze.py ./advi
  • If an option accepts values, they can be separated by a space or by an equal sign (=). This document uses space for all such options. For example, the following are equivalent:
    advixe-python $APM/analyze.py ./advi --out-dir ./report
    advixe-python $APM/analyze.py ./advi --out-dir=./report
  • The target executable must be preceded by two dashes and a space. For example:
    advixe-python $APM/run_oa.py ./advi -- myApplication
    advixe-python $APM/collect.py ./advi -- myApplication
  • If you have Python 3.6 or 3.7 installed and it is the default Python version on your machine, you can run Offload Advisor with your system Python instead of the
    advixe-python
    tool:
    python $APM/run_oa.py ./advi -- myApplication
    python3.6 $APM/run_oa.py ./advi -- myApplication
    python3.7 $APM/run_oa.py ./advi -- myApplication

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