Get Started with the Intel® oneAPI Base Toolkit for Linux*
Intel® oneAPI Base Toolkit
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:
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.
For system wide installations (requires root or sudo privileges):
. /opt/intel/oneapi/setvars.sh
For private installations:
. ~/intel/oneapi/setvars.shThe command above assumes you installed to the default folder. If you customized the installation folder, setvars.sh is in your custom folder.
The setvars.sh 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.sh. If you need to setup the environment in a non-POSIX shell, seeoneAPI Development Environment Setup for more configuration options.
oneapi-cli
The oneAPI CLI menu appears:
After you select a sample, press Enter.
Press Tab to select Create, then press Enter:
cd vector-add make all
make run
make clean
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.
cd <sample_name>
mkdir build cd build
cmake ../. make VERBOSE=1
make run
make clean
See Explore Data Parallel C++ Through Samples to learn more.
You can run the vector-add sample (or any FPGA Data Parallel C++ (DPC++) code) in the following modes:
After downloading the vector-add design example using the oneAPI CLI Samples Browser, perform the following steps to compile and run the design:
cd <vector-add directory on the same system>
make clean -f Makefile.fpga
Compile for emulation using:
make fpga_emu -f Makefile.fpga
Compile the report using:
make report -f Makefile.fpga
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 hw -f Makefile.fpga
If you compiled the hardware on a development system, copy the executable file vector-add.fpga to the runtime system.
make run_emu -f Makefile.fpga
If you are using a separate development system, perform this step on that system.
make run_hw -f Makefile.fpga
To understand the command used in the Makefile, refer to the Intel® oneAPI Programming Guide.
See Explore SYCL* Through Samples to learn more.