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

Get Started

  • 2023.0
  • 12/16/2022
  • Public Content
Contents

Build and Run a Sample Project Using the
Visual Studio*
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
    Microsoft Build*
    .

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.
The oneAPI CLI Samples Browser does not work with system proxy settings and does not support WPAD proxy. If you have trouble connecting from behind a proxy, please see Troubleshooting.
  1. Create a folder where you want to store your sample. For example,
    C:\samples\vector-add
  2. Open a
    command
    window.
  3. Set
     system variables by
    running
     setvars: 
    "C:\Program Files (x86)\Intel\oneAPI\setvars.bat"
    For Windows PowerShell* users, execute this command: 
    cmd.exe "/K" '"C:\Program Files (x86)\Intel\oneAPI\setvars.bat" && powershell'
    The command above assumes you installed to the default folder. If you customized the installation folder,
    setvars.bat
     is in your custom folder.
    The
    setvars.bat
     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 Setvars.bat.
    See
    oneAPI Development Environment Setup for more configuration options.
  4. In the same
    command
    window, run the application : 
    oneapi-cli.exe
    The oneAPI CLI menu appears:
  5. Use the up and down arrow keys to select
    Create a project
    , then press
    Enter
  6. 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.
  7. Select the language for your sample. For your first project, select
    cpp
    , then press
    Enter
    . The toolkit samples list appears.
  8. 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:
  9. After you select a sample, press
    Enter
    .
  10. Specify the location for the project. The default location includes the path from where the utility was run and the name of the project.
  11. Press
    Tab
     to select Create, then press
    Enter
    :


See Explore SYCL* Through Samples to learn more.

Build and Run a CPU or GPU Sample Using Microsoft Build*

  1. Using the same command prompt window where you ran
    setvars.bat
    , navigate to the folder where you downloaded the sample (where the .sln file is located).
  2. Build the program: 
    MSBuild vector-add.sln /t:Rebuild /p:Configuration="Release"
  3. Navigate to the Release folder (example:
    x64/Release
    )
  4. Run the program: 
    vector-add-buffers.exe
A
success
 message will appear:
If
Running on Device
 shows a GPU and an error occurs, see the Troubleshooting tip for fixing a SPIRV Error.

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 third-party vendor-provided BSPs separately. For more information, refer to the Intel® FPGA Add-On for oneAPI Base Toolkit web page.
  1. Using the same command prompt window where you ran
    setvars.bat
    , navigate to the folder where you downloaded the sample (where the .sln file is located). 
    cd <vector-add directory on the same system>
  2. View the
    README.md
     file in the sample folder for instructions on how to build and run the sample.


See Explore SYCL* Through Samples to learn more.

Product and Performance Information

1

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