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

ID 766893
Date 3/31/2023

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

Build and Run a Sample Project Using the Command Line

Intel® oneAPI Base Toolkit

If you have not already configured your development environment, go to Configure Your System then return to this page. If you have already completed the steps to configure your system, continue with the steps below.

Command line development can be done with a terminal window or done through Visual Studio Code*. Some tasks can be automated using extensions. To learn more, see Using Visual Studio Code with Intel® oneAPI Toolkits.

To compile and run a sample:

  1. Locate a sample project using the oneAPI CLI Samples Browser.
  2. Build and run a sample project using Make* or CMake*.

Download Samples using the oneAPI CLI Samples Browser

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

To see a list of components that support CMake, see Use CMake to with oneAPI Applications .

An internet connection is required to download the samples for oneAPI toolkits. For information on how to use this toolkit offline, see Developing with Offline Systems in the Troubleshooting section.

To watch a video presentation of how to create a project with the command line, see Exploring Intel® oneAPI Samples from the Command Line.

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

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

    . /opt/intel/oneapi/

    For private installations:

    . ~/intel/oneapi/

    The command above assumes you installed to the default folder. If you customized the installation folder, is in your custom folder.

    The script can be managed using a configuration file, which is especially helpful if you need to initialize specific versions of libraries or the compiler, rather than defaulting to the "latest" version. For more details, see Using a Configuration File to Manage If you need to setup the environment in a non-POSIX shell, seeoneAPI Development Environment Setup for more configuration options.

  3. In the same terminal window, run the application (it should be in your PATH):


    The oneAPI CLI menu appears:

  4. Use the up and down arrow keys to select Create a project, then press Enter
  5. Move the arrow key down to select Create a project, then press Enter. The language selection will appear. If you want to run samples from a toolkit other than the Intel® oneAPI Base Toolkit, install the domain-specific toolkit before proceeding.

  6. Select the language for your sample. For your first project, select cpp, then press Enter. The toolkit samples list appears.
  7. Select the Vector Add sample. Vector Add is a simple test application that will help verify that the tools are setup correctly and can access your system's GPU:

  8. After you select a sample, press Enter.

  9. Specify the location for the project. The default location includes the path from where the utility was run and the name of the project.
  10. Press Tab to select Create, then press Enter:

Build and Run a Project Based on a oneAPI Sample Using Make

Some samples require additional steps or arguments for building and/or running the sample. Review the sample's file for specific details regarding how to build and run the sample.
  1. Open a command prompt.
  2. Navigate to the directory which you specified when creating (downloading) the project.
  3. Configure the project to use the buffer-based implementation (first box) or the Unified Shared Memory (USM) based implementation (second box).
    mkdir build
    cd build
    cmake ..
    mkdir build
    cd build
    cmake .. -DUSM=1
  4. Build the program.
    make cpu-gpu
  5. Clean the program.
    make clean
  6. Run the program for Unified Shared Memory (USM) and buffers.

Build and Run a Project Based on a oneAPI Sample using CMake

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

Vector add can only be run with Make. To run a different sample using CMake, where <sample_name> is the name of the sample you want to run.

To find a sample that uses CMake, browse the oneAPI Samples GitHub repository and view the README file for each sample to see if the sample can be run with CMake.

  1. If necessary, re-run the command-line utility 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.

Compile and run a sample for FPGA

You can run the vector-add sample (or any FPGA SYCL code) in the following modes:

  • Emulation: Verifies the code correctness. Compilation completes in few seconds. Use this mode if you are using the Intel® oneAPI Base Toolkit
  • Report: Generates a static optimization report for design analysis. Compilation can take a few minutes to complete. When completed, you can find the reports in <project_name>.prj/reports/report.html. This can be used with the Intel® oneAPI Base Toolkit. For more information about the reports, refer to the FPGA Optimization Guide for Intel® oneAPI Toolkits.
  • Hardware: Generates the actual bitstream on an FPGA device. Compilation can take few hours to complete. Use this mode to measure performance. To use this mode, download the Intel® Quartus® Prime Pro Edition software and BSPs separately. For more information, refer to the Install Software for Intel® FPGA Development Flow section in the Intel® oneAPI Toolkits Installation Guide for Linux* OS and Intel® FPGA Add-On for oneAPI Base Toolkit web page.

After downloading the vector-add design example using the oneAPI CLI Samples Browser, perform the following steps to compile and run the design:

  1. Change to the directory containing the vector-add design example using:
    cd <vector-add directory on the same system>
  2. Run the following make clean command before you start compiling.
    make clean
  3. Compile the design using one of the following options:
    • Compile for emulation using:

      make fpga_emu
    • Compile the report using:

      make report

      You can view the report at vector-add_report.prj/reports/report.html. This does not generate an executable.

    • Compile for hardware (takes a longer duration to complete) using:

      make fpga

    If you compiled the hardware on a development system, copy the executable file vector-add.fpga to the runtime system.

  4. Run the design using one of the following options:
    • Run the design for emulation using:

      If you are using a separate development system, perform this step on that system.

    • Run the design on FPGA hardware using:

    To understand the command used in the Makefile, refer to the Intel® oneAPI Programming Guide.

See Explore SYCL* Through Samples to learn more.