Installation¶

Follow the following steps to install and setup the SDK:

Step 1. Cloning the SDK¶

Clone the XCORE SDK repository with the following command:

$ git clone --recurse-submodules https://github.com/xmos/xcore_sdk.git

Step 2. Install Host Applications¶

The SDK includes utilities that run on the PC host. Run the following command to build and install these utilities:

Linux and MacOS

$ cmake -B build_host
$ cd build_host
$ sudo make install

This command installs the applications at /opt/xmos/SDK/<sdk version>/bin/ directory. You may wish to append this directory to your PATH variable.

$ export PATH=$PATH:/opt/xmos/SDK/<sdk_version>/bin/

Windows

Windows users must run the x86 native tools command prompt from Visual Studio

$ cmake  -G "NMake Makefiles" -B build_host
$ cd build_host
$ make install

This command installs the applications at <USERPROFILE>\.xmos\SDK\<sdk version>\bin\ directory. You may wish to add this directory to your PATH variable.

Optional Step 3. Install Python and Python Requirements¶

The SDK does not require installing Python, however, several example applications do utilize Python scripts. To run these scripts, Python 3 is needed, we recommend and test with Python 3.8. Install Python and install the dependencies using the following commands:

Note

You can also setup a Python virtual environment using Conda or other virtual environment tool.

Install pip if needed:

$ python -m pip install --upgrade pip

Then use pip to install the required modules.

$ pip install -r tools/install/requirements.txt

Build & Run Your First Application¶

Once your have installed the SDK, the next step is to build and run your first xcore application.