Installing Intel® oneAPI Toolkits via APT

This page provides general installation and support notes about the Intel oneAPI Toolkits distributed via APT repository.

LEGAL NOTICE: By downloading and using these packages and the included software, you agree to the terms and conditions of the software license agreements located at the End User License Agreements page.

By proceeding you acknowledge that you have read the EULA and agree to the terms and conditions of this agreement.

Important: If you have an existing installation of Intel^® oneAPI Beta, you should remove it before installing the Gold version.

Note: The APT repository is a public repository on the general Internet. If you are on a company intranet behind a firewall you may need to set environment variables https_proxy and http_proxy to your company's proxy server and port. Please contact your local network or system administrators for assistance if you are unfamiliar with using proxy servers.

List of Intel oneAPI Packages

Toolkit Packages

The following toolkits and associated versions are available
THE REPOSITORIES ALWAYS CONTAIN THE LATEST RELEASED VERSION

intel-basekit

intel-basekit-32bit

intel-hpckit

intel-hpckit-32bit

intel-iotkit

intel-iotkit-32bit

 intel-dlfdkit

 intel-dlfdkit-32bit

 intel-aikit

 intel-aikit-32bit

intel-renderkit

intel-renderkit-32bit

intel-oneapi-intelfpgadpcpp-a10gx-s10sx

intel-oneapi-intelfpgadpcpp-custom-platforms-quartus19.4

intel-oneapi-intelfpgadpcpp-custom-platforms-quartus20.2

intel-oneapi-intelfpgadpcpp-custom-platforms-quartus20.3

Runtime Library Packages

The oneAPI repository provides runtime library packages. These packages can be installed on systems that will host oneAPI applications: hosts where you do not want to install the oneAPI Development Toolkits. These are hosts where you run applications but do not do development, compilation, or runtime profiling. The following runtime library packages are available:

•  oneAPI runtime libraries package, which is a superset of all runtimes for oneAPI components:
  • 64-bit: intel-oneapi-runtime-libs
  • 32-bit: intel-oneapi-runtime-libs-32bit
• Component runtime library packages. For instructions on how to get the list of all availbale standalone runtime packages, refer to the List Standalone Runtime Library Packages section of the Appendix.

Installation of Intel^® oneAPI Toolkits on a supported Linux system requires the following steps:

1.  If you have an existing oneAPI Beta installation, remove it before installing Intel oneAPI Gold. After removing your Beta installation you can skip to Step 5.  To remove your Beta oneAPI installations, use this command: 

   apt autoremove 'intel-*kit'  'intel-oneapi*'

    

2. Make sure your OS is supported. The OS version can be found using one of these commands in a terminal window:

   # Redhat, Fedora, CentOS and related
   more /etc/redhat-release
   
   # Ubuntu, Debian, others
   more /etc/lsb-release

   • Look for supported OSes in the System Requirements section in the appropriate Intel® oneAPI Toolkits product pages.
3. Install the required drivers If this is your first installation of Intel oneAPI.
4. Set up your package manager to use the Intel repository as described below.
5. Determine which Intel oneAPI toolkit package or packages you require using the Table of Packages. Write down or copy your package name and follow the installation instructions.
6. (Optional) If you also want to integrate tools into the Eclipse* IDE, Open Eclipse and verify that a menu titled “Intel” is present. If the menu is not present read this guide to Installing Eclipse* Plugins from the IDE.
7. What's Next? Get Started with the Intel® oneAPI Toolkits for Linux*.

Install Intel oneAPI Packages

Intel provides access to all of its oneAPI toolkits and packages through a public APT repository. The apt command is a powerful command-line tool, which works with Ubuntu*'s Advanced Packaging Tool (APT) performing such functions as installation of new software packages, upgrade of existing software packages, updating of the package list index, and even upgrading the entire Ubuntu* system. See below for instructions on how to pull the latest versions of the Intel tools. For more information, visit the official apt command page.

1. If you have an existing oneAPI Beta installation, use apt autoremove <packages> to remove it. For example:

   sudo -E apt autoremove intel-hpckit intel-basekit

    

2. Get the Intel Repository public key and install it. We will do the following from /tmp since both users and root have read/write in /tmp. You can use any other directory where you have read/write as both user and sudo user:

   # use wget to fetch the Intel repository public key
   cd /tmp
   wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
   # add to your apt sources keyring so that archives signed with this key will be trusted.
   sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
   # remove the public key
   rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB

    

3. Configure the APT client to use Intel's repository:

   echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list

   
   Alternatively, if add-apt-repository utility is installed, you can use something like:

   sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"

   
   Download package info for oneAPI toolkit and components.

   sudo apt update

    

4. Install the desired package. Determine which Intel^® oneAPI Toolkit package or packages you require. A Table of Packages is at the top of this page. If you are on a company intranet or behind a firewall make sure to set environment variables http_proxy and https_proxy appropriate to allow apt access the repository servers using https protocol.
5. To install a Toolkit, for example the Intel^® oneAPI Base Toolkit, the meta package name is "intel-basekit" and it can be installed with the following:

   sudo apt install intel-basekit
   #repeat 'apt install ...' for each toolkit you need

    

6. [Optional] See a list of oneAPI packages available for install:

   sudo apt-cache pkgnames intel | grep kit$
   # Other installation options (toolkits and individual components) are available in the form of
   # meta-packages.

    

7. Set up user environment. After oneAPI tools are installed, before accessing the tools, you must set up environment variables to access the tools.
   • See the Before You Begin page for setting up the environment. Then proceed to Run a Sample Project Using the Command Line to confirm correct installation.
   • Consider adding the source of setvars.sh to your ~/.bash_profile startup script. If you manage a multi-user system, consider how to source this script for all login users, such as adding to your /etc/profile startup script or add it to user tools environment using modulefiles or similar.
8. (Optional) If you also want to integrate tools into the Eclipse* IDE, Open Eclipse and verify that a menu titled “Intel” is present. If the menu is not present read this guide to Installing Eclipse* Plugins from the IDE.
9. Installation complete! What's next? Get Started with the Intel^® oneAPI Toolkits for Linux*.

Note: If you have applications with long-running GPU compute workloads in native environments, you must disable the hangcheck timeout period to avoid terminating workloads.

Upgrade Intel oneAPI Toolkit/Component

You can upgrade toolkit or component package to the latest version using the following instructions:

• Toolkit: sudo apt install <toolkit package>
  For example, to upgrade the Intel oneAPI Base Toolkit package to the latest version, use the following command:

  sudo apt install intel-basekit
  

   

• Component: sudo apt install <component package>
  For example, to upgrade the Intel Distribution for GDB* package, use the following command:

  sudo apt install intel-oneapi-dpcpp-debugger

   

Install Intel GPU Drivers

If you are using a discrete Intel GPU, you will need to install the latest drivers because they are not included in oneAPI toolkit installation package.

• Driver installation instructions

Disable Hangcheck

This section applies only to applications with long-running GPU compute workloads in native environments. Not recommended for virtualizations or other standard usages of GPU, such as gaming.

A workload that takes more than four seconds for GPU hardware to execute is a long running workload. By default, individual threads that qualify as long-running workloads are considered hung and are terminated. Disabling the hangcheck timeout period avoids this problem.

NOTE: If the system is rebooted, hangcheck is automatically enabled. You must disable hangcheck again after every reboot or follow the directions below to disable hangcheck persistently (across multiple reboots).

To disable hangcheck until the next reboot:

sudo sh -c "echo N> /sys/module/i915/parameters/enable_hangcheck"

To disable hangcheck across multiple reboots:

1. Open a terminal and run this command:

   Append i915.enable_hangcheck=0 to GRUB_CMDLINE_LINUX_DEFAULT in /etc/default/grub
   Run sudo update-grub

    

2. Reboot the system. Hangcheck will remain disabled.

Have Questions?

Check out the FAQ
See our Get Help page for your support options.

Appendix: Listing Available Toolkits, Components, and Runtime Library Packages

Use the queries provided below to find and install specific toolkits, standalone components, standalone runtime library packages, or simply to see all available packages in oneAPI repository.

List Toolkit Packages

To query the APT repository for available toolkit packages, use the following command:

sudo -E apt-cache pkgnames intel | grep kit | grep -v runtime

List Standalone Components

The oneAPI repository also contains standalone components, which are packages that provide a specific tool for cases where you do not need an entire toolkit. For these packages, if there is a <component>-runtime package, make sure to get and install both the component package and its runtime package. Not all standalone components need an additional runtime package. If you do not see a runtime package for your standalone component, then you do not need one. 
To query the APT repository for available standalone components and their runtime packages, use the following command:

sudo -E apt-cache pkgnames intel | grep intel-oneapi | grep -v intel-oneapi-runtime

List Standalone Runtime Library Packages

The oneAPI repository provides standalone runtime library packages. These packages can be installed on systems that will host oneAPI applications: hosts where you do not want to install the oneAPI Development Toolkits. These are hosts where you run applications but do not do development, compilation, or runtime profiling. In this case, you only need the shared libraries dynamically linked to by executables, provided by these packages.   
To query the APT repository for available component runtime libraries, use the following command:

sudo -E apt-cache pkgnames intel | grep intel-oneapi-runtime

List All Packages

To query all available Intel® oneAPI packages provided in the repository, use the following command:

sudo -E apt-cache pkgnames intel

Have Questions?

Check out the FAQ
See our Get Help page for your support options.

Notices and Disclaimers

Intel technologies may require enabled hardware, software or service activation.

No product or component can be absolutely secure.

Your costs and results may vary.

© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.

No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.

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.

Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.