Get Started

  • 2021.4
  • 09/27/2021
  • Public Content

Build and Run a Sample Project Using Visual Studio Code

Intel® oneAPI HPC Toolkit
Intel® oneAPI
toolkits integrate with third-party IDEs to provide a seamless GUI experience for software development.
If you are using Visual Studio Code (VS Code) with FPGA, see the Intel® oneAPI DPC++ FPGA Workflows on Third-Party IDEs.
An internet connection is required to download the samples for oneAPI toolkits. If you are using an offline system, download the samples from a system that is internet connected and transfer the sample files to your offline system. If you are using an IDE for development, you will not be able to use the oneAPI CLI Samples Browser while you are offline. Instead, download the samples and extract them to a directory. Then open the sample with your IDE. The samples can be downloaded from here:
This procedure requires the Sample Browser extension to be installed. The next section will describe how to install it. If you have already installed it, skip to Create a Project Using Visual Studio Code.

Extensions for Visual Studio Code Users

You can use VS Code extensions to set your environment, create launch configurations, and browse and download samples:
  1. From Visual Studio Code, click on the Extensions logo in the left navigation.
  2. Locate the extension titled
    Sample Browser for Intel oneAPI Toolkits
    , or visit https://marketplace.visualstudio.com/publishers/intel-corporation to browse available extensions.
  3. Click
    Install
    .
  4. Next, locate the extension titled
    Environment Configurator for Intel oneAPI Toolkits
    .
  5. Click
    Install
    .
For more information about VS Code extensions for Intel oneAPI Toolkits, see Using Visual Studio Code* to Develop Intel® oneAPI Applications.

Create a Project Using Visual Studio Code

  1. Click on the oneAPI button on the left navigation to view samples.
    To watch a video presentation of how to install the Sample Browser extension and create a project with Visual Studio Code, see Exploring oneAPI Samples with the Sample Browser in Visual Studio Code.
  2. A list of available samples will open in the left navigation.
  3. To view the readme for the sample, click the next to the sample. If you choose to build and run the sample, the readme will also be downloaded with the sample.
  4. To build and run a sample, click the
    +
    to the right of the sample name.
  5. Create a new folder for the sample. The sample will load in a new window:

Set the oneAPI Environment

  1. Press
    Ctrl+Shift+P
    ( or
    View -> Command Palette…
    ) to open the Command Palette.
  2. Type
    Intel oneAPI: Initialize environment variables
    . Click on
    Intel oneAPI: Initialize environment variables
    .
  3. From the left navigation, click README.md to view instructions for the sample.

Prepare Build Tasks from Make / CMake Files

  1. Press
    Ctrl+Shift+P
    or
    View -> Command Palette…
    to open the Command Pallette.
  2. Type
    Intel oneAPI
    and select
    Intel oneAPI: Generate tasks
    .
  3. Select the build tasks (target) from your Make/CMake oneAPI project that you want to use.
  4. Run the task/target by selecting
    Terminal -> Run task...
    .
  5. Select the task to run.
Not all oneAPI sample projects use CMake. The
README.md
file for each sample specifies how to build the sample. We recommend that you check out the CMake extension for VS Code that is maintained by Microsoft.

Build the Project

The oneAPI extensions enable the ability to prepare launch configurations for running and debugging projects created using Intel oneAPI toolkits:
  1. Press
    Ctrl+Shift+B
    or
    Terminal -> Run Build Task...
    to set the default build task.
  2. Select the task from the command prompt list to build your project.
  3. Press
    Ctrl+Shift+B
    or
    Terminal -> Run Build Task...
    again to build your project.

Prepare Launch Configuration for Debugging

The oneAPI extensions enable the ability to prepare launch configurations for running and debugging projects created using Intel oneAPI toolkits:
  1. Press
    Ctrl+Shift+P
    or
    View -> Command Palette...
    to open the Command Palette.
  2. Type
    Intel oneAPI
    and select
    Intel oneAPI: Generate launch configurations
    .
  3. Select the executable (target) you want to debug.
    Optional: select any task you want to run before and/or after launching the debugger (for example, build the project before debug, clean the project after debug).
  4. The configuration is now available to debug and run using the gdb-oneapi debugger. You can find it in
    .vscode/launch.json
    . To debug and run, click on the Run icon or press
    Ctrl+Shift+D
    .

Debug, Analyze, Develop with More Extensions

There are more oneAPI extensions for Visual Studio Code which enable:
  • debugging
  • remote development
  • connection to Intel DevCloud
  • analysis configuration
To learn more about the extensions, see Intel® oneAPI Extensions for Visual Studio Code*.
To learn more about more capabilities and options, see Using Visual Studio Code with Intel® oneAPI Toolkits.
Not all oneAPI sample projects use CMake. The
README.md
file for each sample specifies how to build the sample. We recommend that you check out the CMake extension for VSCode that is maintained by Microsoft.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.