Intel oneAPI...

Modules

Compilers 

• Intel C,C++ and Data Parallel C++ Compiler - module load intel-compiler/2021.1.1
• Intel Fortran Compiler - module load intel-compiler/2021.1.1

Libraries

• Intel Math Kernel Library (MKL) - module load intel-mkl/2021.1.1
• Intel MPI - module load intel-mpi/2021.1.1
• Intel Threading Building Blocks (TBB) - module load intel-tbb/2021.1.1 
• Intel Data Analytics Library (formerly Data Analytics Acceleration Library) (DAAL) - module load intel-daal/2021.1.1
• Intel Integrated Performance Primitives (IPP) - module load intel-ipp/2021.1.1
• Intel Integrated Performance Primitives for Cryptography (IPPCP) - module load intel-ippcp/2021.1.1 
• Intel Deep Neural Network Library (DNNL) - module load intel-dnnl/2021.1.1 
• Intel Collective Communication Library (CCL) - module load intel-ccl/2021.1.1
• Intel Video Processing Library (VPL)- module load intel-vpl/2021.1.1

Performance profiling and software development tools

• Intel VTune Profiler - module load intel-vtune/2021.1.1 
• Intel Advisor - module load intel-advisor/2021.1.1 
• Intel Inspector - module load intel-inspector/2021.1.1 
• Intel Trace Analyzer and Collector (ITAC) - module load intel-itac/2021.1.1 
• Intel DPC++ Compatibility Tool - module load intel-dpct/2021.1.1 

Intel oneAPI compilers 

The 2021 and onwards intel-compiler  modules contain two sets of C,C++ and Fortran compilers. The compilers present in Intel Parallel Studio XE have been renamed "Intel Compiler Classic", and the new LLVM-based oneAPI compilers are now known as the "Intel Compilers".

The table below shows the "Classic" compiler name, and its oneAPI equivalent. Note that a Data Parallel C++ compiler is new to oneAPI, and was not present in Intel Parallel Studio XE.

Note that despite the name, the "classic" compilers are still under active development, and will be present in every Intel oneAPI installation on Gadi for the foreseeable future. When the intel-compiler module is loaded on Gadi, a number of environment variables are set that control the underlying compilers used by OpenMPI, Intel MPI and the HDF5 compiler wrappers. By default, the intel-compiler module will continue to set these variables such that those libraries will use the "classic" compiler. If you wish to switch to the oneAPI compilers while using an OpenMPI, Intel MPI or HDF5 module present in /apps, the table below shows the variables you need to set after loading the compiler module in order to effect this change.

The intel-compiler-llvm modules have been provided as of oneAPI version 2022.0, which set these environment variables according to the table above. Note that the intel-compiler and intel-compiler-llvm modules both provide access to the "classic" and oneAPI compilers, the only difference between the modules are the values for these environment variables. As of oneAPI 2022.0, the version numbers for the "classic" and oneAPI compilers have diverged. The intel-compiler module carries the version number of the "classic" compiler, and the intel-compiler-llvm module carries the version number of the oneAPI compilers.

Please note that, at time of writing, the oneAPI Intel Fortran Compiler, ifx, is still in beta stage, and our testing has shown that it fails to build several application benchmarks due to internal compiler errors.

Any errors of the type catastrophic error: **Internal compiler error: ... should be reported directly to Intel along with a reproducer. Please also note that several flags commonly used with the Intel Compiler Classic are not supported by the Intel oneAPI compilers. Please check the compiler man pages (man icx or man ifx) for equivalent flags if you see warnings of the form: ifx: command line warning #10148: option '-no-prec-div' not supported .

As of the 2022 release of Intel oneAPI, the intel-compiler-llvm module has been provided that sets all of the above environment variables to their oneAPI compiler settings. Both this module and the intel-compiler module provide access to the Classic and oneAPI compilers, the only difference between the two modules are the values of the environment variables in this section.

This release also marks the divergence of the version numbers of the Classic and oneAPI compilers. The Classic compilers retain the 2021 major version number, whereas the oneAPI compilers have been assigned the 2022 major version number. For example, version 2021.5.0  of the Classic compilers and version 2022.0.0 of the oneAPI compilers were provided in the same release of the oneAPI HPC Toolkit. Intel has also changed the way LLVM components are accessed in the 2022 release of Intel oneAPI, see: https://www.intel.com/content/www/us/en/developer/articles/release-notes/intel-oneapi-dpc-c-compiler-release-notes.html for more information.

The README.txt file found in $INTEL_COMPILER_LLVM_BASE/linux/bin-llvm provides further information. In most cases, this change will have no effect on regular application building, however, if you are building static libraries, and require access to llvm-ar directly, you will need to access it using the path provided by the command dpcpp --print-prog-name=llvm-ar. The method for doing this will vary depending on the build system your project uses. If your project uses autotools, you can modify your makefile as follows:

 AR := $(shell dpcpp --print-prog-name=llvm-ar)

If your project uses CMake, you can add the following argument to your cmake invocation

$ cmake -DCMAKE_AR=$( dpcpp --print-prog-name=llvm-ar )

oneAPI Tool Variants 

Several Intel oneAPI tools have variants available due to incompatible requirements for supporting several languages and threading models. The different variants are selected by setting an environment variable before loading the appropriate module. The tables below detail which tools have variants available. what those variants are, and what environment variable to set to switch between them. A warning will be issued and the module will not load if the environment variable in the table header is set to a value other than one in the "Variant" table column. The (default) variant will be loaded if the environment variable is not present.Module variants

Running module help on any of these modules will display the list of variants and the associated environment variable used to select a variant. Note that to change to a different variant after a module has been loaded, it is necessary to first unload the module, then set the environment variable, then load the module again.

Device Compatibility 

Authors: Dale Roberts, Mohsin Ali