.. vim: syntax=rst

.. include:: ../global.rst
.. _faq-intel-oneapi:

============
Intel OneAPI
============

In December 2020, Intel released its `Intel OneAPI toolkits`_ software
development suite, which is free of charge and replaces the previous
or Intel Parallel Studio XE Compiler Suite that Oden Institute
licensed. In our environment, we install the `Base`_ and `HPC`_
toolkits for our current supported desktop installation, Ubunutu
22.04.  This includes the following libraries and applications:


Programming languages
---------------------

 * Intel oneAPI C++ and Data Parallel C++ compiler - `C/C++ compiler`_ 
 * Intel Fortran Compiler - `Fortran compiler`_ 
 
Since we installed the complete Base and HPC toolkits, there will be
many modules available.  The simplest form for loading the compilers
*icc* and *fortran*::

  $ module load intel/2022.2 icc 
  
  $ ml list
  Currently Loaded Modules:
  1) intel/2022.2   2) compiler-rt/2022.1.0   3) icc/2022.1.0

  $ icc -v
  icc version 2021.6.0 (gcc version 11.2.0 compatibility)
 
  $ ifort -v
  ifort version 2021.6.0

Libraries
---------

The most common library used is *mkl*.

 * `Intel oneAPI Math Kernel Library (MKL)`_ - high performance math
   library 

There are host of other libraries, visit the links in the section
above, they will lead to documentation for the information on the
other installed libraries.

To load the MKL::

  $ ml load intel/2022.2 mkl
  Loading mkl version 2022.1.0
  Loading tbb version 2021.6.0
  Loading compiler-rt version 2022.1.0

  $ ml list

  Currently Loaded Modules:
    1) intel/2022.2   2) tbb/2021.6.0   3) compiler-rt/2022.1.0   4) mkl/2022.1.0

Note, by default this does not load the compiler(s).