
================================================================================
 Intel(R) Xeon Phi(TM) Processor X200 Product Family Performance Workloads:  micp
================================================================================
Version:  1.5.3

Disclaimer and Legal Information:

You may not use or facilitate the use of this document in connection with
any infringement or other legal analysis concerning Intel products described
herein. You agree to grant Intel a non-exclusive, royalty-free license to
any patent claim thereafter drafted which includes subject matter disclosed
herein.

No license (express or implied, by estoppel or otherwise) to any intellectual
property rights is granted by this document.
All information provided here is subject to change without notice. Contact your
Intel representative to obtain the latest Intel product specifications and
roadmaps. The products described may contain design defects or errors known as
errata which may cause the product to deviate from published specifications.
Current characterized errata are available on request.

Copies of documents which have an order number and are referenced in this
document may be obtained by calling 1-800-548-4725 or by visiting:
http://www.intel.com/design/literature.htm (http://www.intel.com/design/literature.htm)
Intel technologies' features and benefits depend on system configuration and
may require enabled hardware, software or service activation. Learn more at
http://www.intel.com/ (http://www.intel.com/) or from the OEM or retailer.
No computer system can be absolutely secure.
Intel, Xeon, Xeon Phi and the Intel logo are trademarks of Intel Corporation
in the U.S. and/or other countries.

*Other names and brands may be claimed as the property of others.

Copyright 2012-2017, Intel Corporation, All Rights Reserved.


================================================================================
 Table of Contents
================================================================================
  1. Requirements
  1.1   Python Requirements
  1.2   Intel(R) Composer XE Requirements
  1.3   PuTTY Requirements
  1.4   MATPLOTLIB Requirements

  2. Distributed Files

  3. Python Installation

  4. Alternative to Python Installation


================================================================================
1.   Requirements
================================================================================

1.1  Python Requirements

Python is required to be installed.  The package is tested against
Python 2.7 which can be downloaded here:

http://www.python.org/ftp/python/2.7.5/python-2.7.5.msi

and the MD5 checksum is:

0006d6219160ce6abe711a71c835ebb0

we recommend the standard version rather than the x86_64 version for
compatibility with matplotlib and its requirements.


1.2  Intel(R) Composer XE Requirements

There are two options to installing the Intel(R) Composer XE
requirements.  The first option is to install the full Intel(R)
Composer XE MSI package.

If the full composer installation is not available, then two packages
can be used instead.  The required shared object libraries can be
installed via the Intel(R) Composer XE redistributable package
freely distributed on the web here:

https://software.intel.com/en-us/articles/redistributables-for-intel-parallel-studio-xe-2015-composer-edition-for-windows

This download has an MSI package which will set up the environment and
install the required dependencies.

Besides the shared object libraries, the MKL Linpack benchmark is also
a requirement.  This is also freely distributed on the web and can be
downloaded here:

http://software.intel.com/en-us/articles/intel-math-kernel-library-linpack-download

This download is a zip file that can be unpacked anywhere, but the
environment variable MKLROOT must point to the top level directory of
the untarred package.  For instance, if the user extracted the zip file
into their home directory they should set MKLROOT as follows:

user_prompt> set MKLROOT=%HOMEPATH%\linpack_11.1.0

If MKLROOT is set in the user's shell environment at run time then
micprun will be able to locate the linpack binaries.  Note that the
version of linpack linked above may be newer than 11.1.0, and MKLROOT
variable should reflect this.


1.3  PuTTY Requirements

The PuTTY command line utilities pscp.exe and plink.exe must be
installed to a location referenced by the user's PATH environment
variable.  These can be downloaded here:

http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

Note that the user ID and SSH key required to log into the card can be
set with the environment variables INTEL_MPSS_USER and
INTEL_MPSS_SSH_KEY repectively.  Note that INTEL_MPSS_SSH_KEY should
be the path to the PuTTY SSH key file.

1.4  MATPLOTLIB Requirements

The micpplot and micprun applications use the MATPLOTLIB Python module
to plot performance statistics.  The micprun application only creates
plots when verbosity is set to two or higher, and only requires
MATPLOTLIB for this use case.  MATPLOTLIB must be installed in order
to create plots.  Visit

http://matplotlib.sourceforge.net

to download.


================================================================================
2.  Distributed Files
================================================================================

The micperf software is part of the MPSS MSI package and will be
installed along with the rest of MPSS by default.  The MPSS MSI
installs the micperf files to the directories:

Benchmark source code:       C:\Program Files\Intel\MPSS\sdk\tutorials\micperf
Python source distribution:  C:\Program Files\Intel\MPSS\sdk\micperf\micp
Benchmark binaries:          C:\Program Files\Intel\MPSS\sdk\micperf\libexec
Reference data:              C:\Program Files\Intel\MPSS\sdk\micperf\data


================================================================================
3.  Python Installation
================================================================================

Once the MSI package has been installed an additional step must be
done to access the micp Python package:  either install it to your
global Python site packages, or set up your environment to use the
micp package from from the installed location.

To install into the Python site packages open a command prompt as
administrator and run the following two commands:

user_prompt> cd C:\Program Files\Intel\MPSS\sdk\micperf\micp
user_prompt> python setup.py install

This method will provide access to the micp package and executable
scripts by all users of the Python version of the administrator. If
python is in the default location and uses a standard configuration
setup.py installs the micp package to the directories:

C:\PythonXY\Scripts
C:\PythonXY\Lib\site-packages\micp

An intermediate product of running "setup.py install" is the creation of
the directory:

C:\Program Files\Intel\MPSS\sdk\micperf\micp\build

None of the products of running setup.py discussed above will be
removed by uninstalling the MPSS MSI.  The installation with setup.py
uses python's distutils module, and this module does not support
uninstall.


================================================================================
4.  Alternative to Python Installation
================================================================================

Another way to access the micp package after installing the MSI is to
alter the shell run time environment of a user.  The PYTHONPATH and
PATH environment variables can be set globally as explained here:

http://support.microsoft.com/kb/310519

or they can be set locally in the command shell using the set command

user_prompt> set PYTHONPATH=C:\Program Files\Intel\MPSS\sdk\micperf\micp;%PYTHONPATH%
user_prompt> set PATH=C:\Program Files\Intel\MPSS\sdk\micperf\micp;%PATH%

This method has the benefit of allowing the use of MSI mechanism to
uninstall the package, and if environment variables are changed
globally it will be valid for all users of the system.
