EQuUs MKL installation guide

  Copyright (C) 2016 Peter Rakyta, Ph.D.

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

System requirements

EQuUs MKL was successfully compiled and tested with Intel compiler v16.0.2 including MKL v11.2.3.187 and with Intel compiler v12.1.5 including MKL v10.3.11. (EQuUs MKL can also be compiled and linked with the GNU compiler)

Download

Download the EQuUs v4.8 from the list of provided stable packages. Altrenatively the EQuUs v4.8 package can be downloaded by the shell command

wget http://eqt.elte.hu/equus/Downloads/EQuUs_v4.8.tar.gz

Unpack

Unpack the downloaded package into the directory "/path/to/EQuUs" with the commands

mkdir /path/to/EQuUs

and

tar -xzf EQuUs_v4.8.tar.gz -C /path/to/EQuUs

to create the output directory and unpack the package respectively.

Install

Currently the configuration files for the compilation are given only for Unix system. For Windows system please create appropriate configuration files. (Binaries compiled on Unix system can not be used on other operating systems.)

To compile the EQuUs MKL component one needs to setup environment variables EQUUSDIR=/path/to/EQuUs and the standard built-in environment variables of the Intel compiler.

After the environment variables were successfully set, please open and edit the file /path/to/EQuUs/MKL/commonvars.in. This file contains some other variables needed to be also given for a successful installation:

• MATLABROOT=path/to/the/MATLAB/installation
• OCTAVEROOT=path/to/the/octave/installation
• COMPILER_F=path/to/the/C/compiler/binary
• COMPILER_C=path/to/the/C/compiler/binary

For the compilation use the provided makefile in the directory /path/to/EQuUs/MKL/. The makefile can be run with the following syntax:

make [debug] [THREAD=SEQ/PAR/MIC] [LINKING=static/dynamic] [BUILD=matlab/octave]

• Use the option debug for verbose compilation.

• Use the option THREAD=SEQ for single threaded compilation, THREAD=PAR for multi threaded (openMP) compilation, or THREAD=MIC for Intel MIC compilation.

• Use the option LINKING=static for static linking of the produced MEX files (thus the MEX files becomes transferable) or LINKING=dynamic for dynamic linking (using shared libraries provided by the system).

• Use the option BUILD=matlab for compilation for MATLAB or BUILD=octave for compilation for octave.