Intel® Math Kernel Library (Intel® MKL) 2020 Install Guide

By John R. O'Connell, Published: 12/11/2019, Last Updated: 12/11/2019

Please see the following links available online for the latest information regarding the Intel® Math Kernel Library (Intel® MKL):

You can find links to documentation, help, and code samples on the main Intel® MKL product page. For technical support, visit the Intel® MKL technical support forum and review the articles in the Intel® MKL knowledgebase.

Please register your product using your preferred email address. This helps Intel recognize you as a valued customer in the support forum and ensures that you will be notified of product updates. You can read Intel's Online Privacy Notice Summary if you have any questions regarding the use of your email address for software product registration.

Introduction

These instructions assume an installation of Intel® MKL as a component of Intel® Parallel Studio XE 2020 Composer Edition. If your copy of Intel® MKL was included as part of another product suite (for example, Intel® Parallel Studio XE 2020 Professional Edition for FORTRAN, Intel® Parallel Studio XE 2020 Cluster Edition, and so on), your installation procedure may be different than that described below. Refer to the readme and installation guides for your product suite for specific installation details.

Before installing Intel® Parallel Studio XE 2020 Composer Edition that includes Intel® MKL, check the Product Downloads section of the Intel® Registration Center to see if a newer version of the Intel® Parallel Studio XE 2020 Composer Edition product is available. The version listed in your online download license letter may not be the most current version available.

If you have a previous version of Intel® Parallel Studio XE 2020 Composer Edition that includes Intel® MKL installed, you do not need to uninstall it before installing a new version. If you choose to uninstall the older version, you may do so at any time.

Note: Intel® MKL cluster components can be installed only as part of Intel® Parallel Studio XE 2020 Cluster Edition.

Intel® MKL Library Directory Layout

The default installation directory for a standalone installation of Intel® MKL is:

Linux* OS: /opt/intel/parallel_studio_xe_2020.u.xyz/compilers_and_libraries_2020/linux/mkl/ (where u is the update number, 0 is for gold releases, and xyz is the package number)

In the following table, <arch> refers to the primary processor architecture, such as ia32 or intel64 and <MKLROOT> refers to the Intel® MKL installation directory. Additionally, substitute a '/' below for the '\' if your system is a Linux* OS or macOS* system.

Within the Intel® MKL root installation directory you will find a collection of subdirectories.

Intel® MKL Installation Directory Structure
Directory Description
<MKLROOT>\bin\<arch>\
Contains the scripts recommended for configuring the environment for the purpose of building the library and or library components.
<MKLROOT>\include\
Contains the interface files defining data types and function prototypes for Intel® MKL. See the getting started page for more information.
<MKLROOT>\lib\<arch>\
Contains the library files that you must link against when building your Intel® MKL application. These include the Intel® MKL static library files and dynamic library files (Linux* and macOS*). On Windows* the dynamic libraries are located in the redist folder.
<MKLROOT>\tools\
Contains tools that are useful, but not necessary, to facilitate building Intel® MKL applications.
<MKLROOT>\benchmarks\
Contains the Intel® Optimized LINPACK and Intel® Optimized MP LINPACK benchmark for clusters. They are also available as a separate download.
<MKLROOT>\interfaces\
Contains alternate interfaces for high-level languages or for compatibility with other libraries.
<MKLROOT>\examples\
Contains alternate interfaces for high-level languages or for compatibility with other libraries.
<MKLROOT>\..\redist\<arch>\mkl\

Windows specific.

Contains the Intel® MKL dynamic libraries that you may distribute with your Intel® MKL application when linking against the shared libraries.


Note: The ..\ directory reference; the redist directory is located outside of the normal mkl directory.

<MKLROOT>\..\redist\<arch>\compiler\

Windows specific.

Contains additional dynamic libraries that you may need to distribute with your Intel® MKL application when linking against the shared libraries. In particular, the Intel® MKL library utilizes the Intel OpenMP library to implement multi-threading, and those OpenMP library files can be found in this directory.  

<MKLROOT>\..\redist\<arch>\tbb\

Windows specific.

Contains additional dynamic libraries that you may need to distribute with your Intel® MKL application when linking against the shared libraries. In particular, the Intel® MKL library utilizes the Intel TBB library to implement multi-threading, and those TBB library files are in this directory.

Other optional or informational directories may also be present in the <MKLROOT> directory.

Installing Intel® MKL on a Microsoft* Windows* OS System

You can install multiple versions of Intel® MKL and any combination of 32-bit and 64-bit variations of the library on your development system. Each installation package of Intel® MKL includes the full set of SIMD microarchitectures supported by Intel® MKL.

These instructions assume you have an internet connection. The installation program automatically downloads a serial number to your system. If you do not have an internet connection, see the manual installation instruction section below.

  1. Download the Intel® Parallel Studio XE 2020 Composer Edition product from Intel Registration Center. There are two different packages to choose from. The parallel_studio_xe_2020_composer_edition_setup.exe installer contains all components while the parallel_studio_xe_2020_composer_edition_online_setup.exe installer requires an internet connection to access components online.
  2. Choose your destination directory (C:\Program Files (x86)\IntelSWTools  is the default) in which the contents of the self-extracting setup file will be placed before the actual library installation begins. After the installation is complete, these install files will still be located in this directory. You can safely remove the files in this directory if you need to free up disk space; however, deleting these files impacts your ability to change your installation options at a later time using the add/remove applet. You will always be able to uninstall.
  3. Choose your target platform architecture. In Windows*, you could choose IA-32/Intel® 64 or install both. In the Select Components to install dialog box, you can deselect components that are not required or select the components which are not installed by default. Note: PGI C/C++ and Fortran compilers Support for Intel® 64,is not installed by default. 

  4. Click Next to accept the End User License Agreements (EULA). 
  5. If you have installed previous version of Intel® Parallel Studio, some components IDE integration(s) will be replaced with the 2020 version. This is OK because the new release is also compatible with an older version (Note: You will no longer be able to select version 16.0 or older Intel Visual C/C++ and Fortran Compilers from the Visual Studio IDE).
  6. Click Next to set up the License activation and IDE Integration. In the License activation part:
    a) If you do have an Internet connection, you only need to provide a serial number. The installer checks with the Intel Registration Center.
    b) If you do not have an Internet connection, or require a floating or counted license manager installation, click choose alternate activation to use offline activation using a license file or license manager. There are two options to choose from:
    -License file activation: requires a License File.
    -Floating license activation: 
    provide host name and port number.
     
  7. The package contains components for integration into Microsoft* Visual Studio*. You can select the Microsoft Visual Studio product(s) for integration on the Choose Integration Target page.
  8. Note: This step only applies if you are installing the Intel Parallel Studio XE 2020 Cluster Edition. If the Microsoft Compute Cluster Pack* is present, and the installation detects that the installing system is a member of a cluster, you can opt to install the product on all visible nodes of the cluster or on the current node only. By default, the installation on all visible nodes is performed.
  9. Click Next to complete activation and IDE integration customization and begin the installation.
  10. Click Finish in the final screen to exit the Intel Software Setup Assistant.

Online Installation for Intel® Math Kernel Library 2020 for Windows

The default online installation package for Intel® Math Kernel Library 2020 for Windows consists of a smaller installation package that dynamically downloads and then installs packages selected for installation. This requires a working internet connection and potentially a proxy setting if you are behind an internet proxy. Full packages are provided from the same download location as the online install package if a working internet connection is not available.

Silent Installation

Silent installation enables you to install Intel® MKL on a single Windows* machine in a batch mode, without input prompts. Use this option if you need to install on multiple similarly-configured machines, such as cluster nodes.

To invoke silent installation:

  • Go to the folder where the Intel Parallel Studio XE 2020 Composer Edition package was extracted during unpacking. The default location is the C:\Users\Administrator\Downloads\Intel\parallel_studio_xe_2020_composer_edition_setup directory.
  • Run install.exe, located in this folder, as follows: install.exe command arguments

If you do not specify a command, the installation proceeds in the Setup Wizard mode. If you do specify a command, the installation proceeds in the non-interactive (silent) mode.

The table below lists the possible values and the corresponding arguments.

        

Command

Required Arguments

Optional Arguments

Action

install

output=<file>,

eula={accept|reject}

installdir=<installdir>,

license=<license>,

sn=<s/n>,

log=<log file>

Installs the product as specified by the arguments:

  • Use the output argument to define the file where the output will be redirected. This file contains all the installer's messages that you may need: general communication, warning, and error messages.
  • Explicitly indicate by eula=accept that you accept the End-user License Agreement.
  • Use the license argument to specify a file or folder with the license to activate the product. If a folder is specified, the installation program searches for *.lic files in the specified folder. You can specify multiple files/folders by supplying this argument several times or by concatenating path strings with the ";" separator.
  • Use the sn argument to choose activation of the product through a serial number. This activation method requires an internet connection.
  • Do not use he sn and license arguments together because they specify alternative activation methods. If you omit both arguments, the installer only checks whether the product is already activated.
  • Use the log argument to specify the location for a log file. This file is used only for debugging. Support Engineers may request this file if your installation fails.

remove

output=<file>

log=<log file>

Removes the product. See the description of the install command for details of the output and log arguments.

repair

output=<file>

log=<log file>

Repairs the existing product installation. See the description of the install command for details of the output and log arguments.

For example, the following command launches a silent installation that prints output messages to the C:\log.txt file.

install.exe install -output=C:\log.txt -eula=accept

Uninstalling Intel® MKL

To uninstall Intel® MKL, you can delete Intel Parallel Studio XE 2020 Composer Edition with all components including MKL 2020. To do this select it in the Add or Remove Programs from the Control Panel.

To uninstall the Intel® MKL 2020 product only, run the executable file used to install Intel® Parallel Studio XE 2020 Composer Edition and select the Modify option. On the component selection dialog, click Intel  Math Kernel Library 2020 or on included components and select Remove and continue the installation flow by clicking Next.

Note: Uninstalling Intel® MKL does not delete the corresponding license file.

License File Installation for Windows* OS

If you have an evaluation license and decide to upgrade to a commercial license, you must complete the following steps after obtaining the commercial serial number:

  1. Replace your evaluation license file (.lic file) with the commercial license file you received in the license file directory (the default license directory is C:\Program Files\Common Files\Intel\Licenses).
  2. Register the new serial number at https://registrationcenter.intel.com.
  3. Re-installation of Intel® MKL is not required.

Uninstalling Intel® MKL does not delete any corresponding license files.

Installing Intel® MKL on a Linux* OS System

The installation of the product requires a valid license file or serial number. If you are evaluating the product, you can also choose the Evaluate this product (no serial number required) option during installation.

You do not need to uninstall previous versions or updates before installing a newer version. The new version will coexist with the older versions.

Note: You can deselect components that are not required or select the components which are not installed by default. For example, PGI C/C++ and Fortran compilers support such as Libmkl_pgi_thread.* and ScaLAPACK libraries such as libmkl_scalapack_*.*  are not installed by default. If you need them, please select customize during the install process.

Interactive Installation on Linux* OS System

  1. If you received the product as a downloadable archive, first unpack the Intel® MKL packagetar -xvzf name_of_downloaded_file.
  2. Change the directory (cd) to the folder containing unpacked files.
  3. Run the installation script and follow the instructions in the dialog screens that are presented: > ./install.sh
  4. The install script checks your system and displays any optional and critical prerequisites necessary for a successful installation. You should resolve all critical issues before continuing the installation. You can skip optional issues, but Intel strongly recommends that you fix all issues before continuing with the installation.
  5. Not all Intel® MKL components are selected for installation by default. If you’d like to change the set of components, choose the Customize installation option on the Installation summary dialog and proceed to the Change components to install dialog.

GUI installation for Intel® Math Kernel Library 2020 for Linux* OS

If you are on a Linux* system with GUI support, the installation will provides a GUI-based installation. If a GUI is not supported (for example, if running from an ssh terminal), a command-line installation is provided.

To install Intel® Math Kernel Library 2020 for Linux* OS  in GUI mode, run shell script (install_GUI.sh).

Silent Installation on Linux* OS System

To run the silent installation, follow these steps:

  1. If you received the product as a downloadable archive, first unpack the Intel® MKL package.
    >tar -xvzf name_of_downloaded_file
  2. Change the directory (cd) to the folder containing unpacked files.
  3. Edit the configuration file silent.cfg following the instructions in it:
    1. Accept the End User License Agreement by specifying ACCEPT_EULA=accept instead of the default decline value.
    2. Specify the activation option for the installation.
      1. The default option is to use the existing license (ACTIVATION_TYPE=exist_lic). Ensure that a working product license file is in place before beginning. The file should be word-readable and located in a standard Intel license file directory, such as /opt/intel/licenses or ~/licenses.
      2. To use an alternate activation method, change the value of the ACTIVATION_TYPE variable. You may also need to change the values of the ACTIVATION_SERIAL_NUMBER and ACTIVATION_LICENSE_FILE variables for specific activation options.
      3. If you want to install Cluster support in addition to the default components, add the following to the list of COMPONENTS: ;intel-mkl-ps-cluster-devel__x86_64;intel-mkl-ps-cluster-common__noarch;intel-mkl-ps-cluster__x86_64;intel-mkl-ps-cluster__i486;intel-mkl-ps-cluster-devel__i486. Exclude the components with the x86_64 suffix if you are using IA-32 system.
  4. Run the silent install:
    >./install.sh --silent ./silent.cfg

    Tip: You can run the installation interactively and record all the options in a custom configuration file using the following command.

    >./install.sh  --duplicate “./my_silent_config.cfg”

    After this you can install the package on other machines with the same installation options using

    >./install.sh --silent “./my_silent_config.cfg”

License File Installation for Linux* OS

If you have an evaluation license and decide to upgrade to a commercial license, you must complete these steps after obtaining the commercial serial number:

  1. Replace your evaluation license file (.lic file) with the commercial license file you received in the license file directory (the default license directory is /opt/intel/licenses).
  2. Register the new serial number at https://registrationcenter.intel.com. Re-installation of Intel® MKL is not required.

Online Installation for Intel® Math Kernel Library 2020 for Linux* OS

The default online installation package for Intel® Math Kernel Library 2020 for Linux consists of a smaller installation package that dynamically downloads and then installs packages selected to be installed. This requires a working internet connection and potentially a proxy setting if you are behind an internet proxy. Full packages are provided from the same download location as the online install package if a working internet connection is not available.

Offline Installation for Intel® Math Kernel Library 2020 for Linux* OS

If the system where Intel® MKL will be installed is not connected to the internet, you can install the product in offline mode.

To install product in offline mode, you must provide the full path to the license file to the installer.

The license file (.lic file) is included as an email attachment that you receive after purchasing and registering the product on IRC. User may request to resend the .lic file from IRC. To do this, go to the My Intel Products page, select the needed update for Intel® MKL from the Download Latest Update column. When the information about the selected product update page opens, click Manage reference in the Licenses column. When the Manage License page opens, click Resend license file to my email.

Installation Modes for Offline Installation
Installation Mode Steps
GUI mode
  1. On the Activation options dialog, select the Choose alternative activation option.
  2. Click Next.
  3. Select the Activate offline option and click Next.
  4. Enter the full path to the license file and click Next.
Interactive mode
  1. Select the I want to activate by using a license file, or by using Intel(R) Software option on the Step 3 Activation step.
  2. On next step, select the Activate offline [default] option and enter the full path to the license file.
Silent mode
  1. Set the license_file value for the ACTIVATION_TYPE variable.
  2. Set the full path to the license file to the ACTIVATION_LICENSE_FILE variable.

 

Customize Install

You can deselect components that are not required or select the components which are not installed by default. The following table is an example installation for the PGI compilers Support for library like Libmkl_pgi_thread.* component.

Component Example Installation
Installation Mode Steps
GUI mode
  1. Click Customize.
  2. Select the PGI* Component Support option.
Interactive mode
  1. Select the Customize installation option on the Step 5 Installation step.
  2. Follow the instructions to customize the component. The PGI component is item 4.
  3. Continue your installation.

 

Uninstalling Intel® MKL for Linux* OS

If you installed as root, you must log in as root.

To uninstall Intel® MKL run the uninstall script: <install-dir>/uninstall.sh.

If you installed in the default directory <install-dir>, use:

> /opt/intel/parallel_studio_xe_2020.u.xyz (where u is the update number, 0 is for gold releases, and xyz is the package number)

Alternatively, you can uninstall Intel® MKL for Linux* OS in GUI mode. First, run the shell script install_GUI.sh, then select the Remove option from menu and click Next.

Uninstalling Intel® MKL does not delete your license file(s).

Obtaining Technical Support

As a registered customer, you are eligible to receive direct, secure technical support for the tools provided with this product via the Online Service Center web site. Register here using your product serial number.

If your distributor provides technical support for this product, please contact them instead of Intel.

For information about Intel® MKL FAQ's, tips and tricks, users forums, and other support information, visit the Intel® MKL Support Website. For general product support please visit http://www.intel.com/software/products/support/.

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