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 FPGA Workflows on Third-Party IDEs for Intel® oneAPI Toolkits.
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
To watch a video presentation of how to install extensions and use them to set up your environment, explore sample code, and connect to the Intel® Developer Cloud using Visual Studio Code, see
oneAPI Visual Studio Code Extensions.
You can use VS Code extensions to set your environment, create launch configurations, and browse and download samples:
- From Visual Studio Code, click on the Extensions logo in the left navigation.
- Locate the extension titledSample Browser for Intel oneAPI Toolkits, or visit https://marketplace.visualstudio.com/publishers/intel-corporation to browse available extensions.
- ClickInstall.
- Next, locate the extension titledEnvironment Configurator for Intel oneAPI Toolkits.
- ClickInstall.
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
- Click on the oneAPI button on the left navigation to view samples.To watch a video presentation of how to install extensions and use them to set up your environment, explore sample code, and connect to the Intel® Developer Cloud using Visual Studio Code, see oneAPI Visual Studio Code Extensions.
- A list of available samples will open in the left navigation.
- 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.
- Find the sample you want to build and run. Click the
to the right of the sample name.
- Create a new folder for the sample. The sample will load in a new window:
Set the oneAPI Environment
- PressCtrl+Shift+P( orView -> Command Palette…) to open the Command Palette.
- TypeIntel oneAPI: Initialize environment variables. Click onIntel oneAPI: Initialize environment variables.
- From the left navigation, click README.md to view instructions for the sample.
Prepare Build Tasks from Make / CMake Files
- PressCtrl+Shift+PorView -> Command Palette…to open the Command Pallette.
- TypeIntel oneAPIand selectIntel oneAPI: Generate tasks.
- Select the build tasks (target) from your Make/CMake oneAPI project that you want to use.
- Run the task/target by selectingTerminal -> Run task....
- 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:
- PressCtrl+Shift+BorTerminal -> Run Build Task...to set the default build task.
- Select the task from the command prompt list to build your project.
- PressCtrl+Shift+BorTerminal -> 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:
- PressCtrl+Shift+PorView -> Command Palette...to open the Command Palette.
- TypeIntel oneAPIand selectIntel oneAPI: Generate launch configurations.
- 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).
- 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 pressCtrl+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 Developer Cloud
- 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.
See
Explore SYCL* Through Samples to learn more.