Get Started with the Intel® oneAPI HPC Toolkit for Linux*

Download PDF
ID 766887
Date 6/30/2025
Public
Document Table of Contents
Document Table of Contents x
Get Started with the Intel® oneAPI HPC Toolkit for Linux*
Get Started with the Intel® oneAPI HPC Toolkit for Linux* x
Configure Your System Build and Run a Sample Using the Command Line Run a Sample with Eclipse* Build and Run a Sample Using Visual Studio Code Using Containers Using Cloud CI Systems Next Steps Using Intel Compilers and Libraries for the Best Experience Troubleshooting Notices and Disclaimers
Build and Run a Sample Using the Command Line x
Download Samples using the oneAPI CLI Samples Browser Build and Run a Sample Using Make* Build and Run a Sample using CMake Next Steps
Next Steps x
SSH: Running Applications Built with Eclipse* SSH: Password-less Access to Remote Linux* Target
Run a Sample with Eclipse* x
Next Steps
Next Steps x
SSH: Running Applications Built with Eclipse* SSH: Password-less Access to Remote Linux* Target
Build and Run a Sample Using Visual Studio Code x
Next Steps
Next Steps x
SSH: Running Applications Built with Eclipse* SSH: Password-less Access to Remote Linux* Target
Using Containers x
Using Containers with the Command Line Using Containers with Eclipse*
Next Steps x
SSH: Running Applications Built with Eclipse* SSH: Password-less Access to Remote Linux* Target
Get Started with the Intel® oneAPI HPC Toolkit for Linux*

Build and Run a Sample Using the Command Line

You can use a terminal window or Visual Studio Code* for command-line development. Some tasks can be automated using extensions. To learn more, seeUsing Visual Studio Code with Intel® oneAPI Toolkits.

Before you begin, make sure your development environment is set up. If you have not already configured your environment, go to Configure Your System before proceeding.

To compile and run a sample:

  1. Download the sample using the oneAPI CLI Samples Browser.
  2. Compile and run the sample with Make*

Download Samples using the oneAPI CLI Samples Browser

Use the oneAPI CLI Samples Browser to explore the collection of online oneAPI samples. The oneAPI CLI utility is a single-file, stand-alone executable that has no dependencies on dynamic runtime libraries. You can copy samples to your local disk as buildable sample projects. The build instructions are included as part of the sample in a README file. Most oneAPI sample projects are built using Make or CMake.

Watch a video walkthrough of creating a sample project:Exploring Intel® oneAPI Samples from the Command Line.

To download and set up a sample:

  1. Open a terminal window.
  2. If you did not complete the steps in One time set up for setvars.sh in the Configure Your System section, set system variables by sourcing setvars:

    Component Directory Layout:

    For system-wide installations (requires root or sudo privileges): 

    . <install_dir>/setvars.sh

    For local installations: 

    . ~/intel/oneapi/setvars.sh

    Unified Directory Layout:

    For system-wide installations (requires root or sudo privileges): 

    . <install_dir>/<toolkit-version>/oneapi-vars.sh

    For local installations: 

    . ~/intel/oneapi/<toolkit-version>/oneapi-vars.sh
    The command above assumes you used the default install location. If you customized the installation folder, adjust the path to setvars | oneapi-vars accordingly.
  3. In the same terminal window, run the application (it should be in your PATH): 

    oneapi-cli

    The oneAPI CLI menu appears:

  4. Move the arrow key down to select Create a project, then press Enter. The language selection will appear.

  5. Select the language for your sample. For your first project, select cpp, then press Enter. The toolkit samples list appears.
  6. Select the Matrix Multiply sample which appears at the top of the list:

  7. After you select a sample, press Enter.

  8. Specify the location for the project. The default location includes the path from where the CLI Browser was run and the name of the project.

  9. Press Tab to select Create, then press Enter:

Now that you have the samples downloaded, compile and run the sample with CMake* .

Build and Run a Sample Using Make*

NOTE:
The Matrix Multiplier sample does not require CMake*, but many of the other samples do. If you have not installed CMake, follow the directions Configure Your System.

Build the matrix_mul Program using Make: 

cd matrix_mul &&
make all

NOTE:
Some samples require additional steps or arguments for building and/or running the sample. Review the sample's README.md file for specific details regarding how to build and run the sample.

Run the Program 

make run

Clean the Program 
make clean

Build and Run a Sample using CMake

To run a different sample using CMake, where <sample_name> is the name of the sample you want to run:

  1. If necessary, re-run the command-line Browser and select a CMake project that contains a CMakeLists.txt file. 
    cd <sample_name> &&
  2. Navigate to the build directory. 
    mkdir build &&
cd build &&
  3. Build the program. Run CMake in the build directory to create the makefile. Use the newly created makefile to build the executable. 
    cmake ../. &&
make VERBOSE=1
  4. Run the program. 
    make run
  5. Clean the program. 
    make clean

See Explore SYCL* Through Samples to learn more.
Parent topic: Get Started with the Intel® oneAPI HPC Toolkit for Linux*
Level Two Title