Skip to content


Repository files navigation

alt tag

Introductory Examples for using PYNQ with Alveo

This project includes introductory examples for using PYNQ with Alveo. It requires pynq version 2.5.1 and above to work.

Refer to the README in the overlays folder for more information regarding the used overlays and how they are created.

Please notice that not all overlays might be available for all target devices. Supported devices are listed in the overlays README. There you may also find instructions on how to synthesize and use overlays for a different device.

Quick Start

Install the pynq-alveo-examples package using pip:

pip install pynq-alveo-examples

After the package is installed, to get your own copy of all the notebooks available run:

pynq get-notebooks

You can then try things out by doing:

cd pynq-notebooks
jupyter notebook

There are a number of additional options for the pynq get-notebooks command, you can list them by typing

pynq get-notebooks --help

You can also refer to the official PYNQ documentation for more information regarding the PYNQ Command Line Interface and in particular the get-notebooks command.