Set up a development machine

Koheron SDK V1 documentation. The V1 branch is recommended for new instrument development and remains under active development ahead of the major release. Boards currently ship with V0; build and install a V1 OS image to follow this workflow. V1 images do not support legacy V0 instruments.

Reference host: Ubuntu 24.04 with Vivado/Vitis 2025.1.

Clone the SDK branch

git clone https://github.com/Koheron/koheron-sdk.git
cd koheron-sdk

Host requirements

Install Vivado and Vitis 2025.1 at the default paths:

/tools/Xilinx/2025.1/Vivado
/tools/Xilinx/2025.1/Vitis

Override VIVADO_PATH and VITIS_PATH on the Make command line for other installation paths.

Run the setup target

make setup

Installs host dependencies, the Python environment and Koheron package, Docker and SDK Docker images. Vivado and Vitis are installed separately.

If Docker was just configured for your user, log out and back in before building without sudo.

Verify the installation

make doctor CFG=examples/alpha250/fft/config.mk
make -j CFG=examples/alpha250/fft/config.mk

Prepare the board

Build and install a V1 OS image for your board. Boards ship with V0.

Verify deployment

make -j CFG=examples/alpha250/fft/config.mk HOST=192.168.1.100 run

HOST is the board IP address. run streams logs; Ctrl+C leaves the instrument running.

Build artefacts

Generated files are written under tmp/<project>/, with board-level image inputs under tmp/<board>/.