PYNQ is an open-source project from Xilinx that makes it easy to design embedded systems with Zynq All Programmable Systems on Chips (APSoCs). Using the Python language and libraries, designers can exploit the benefits of programmable logic and microprocessors in Zynq to build more capable and exciting embedded systems. PYNQ users can now create high performance embedded applications with
- parallel hardware execution
- high frame-rate video processing
- hardware accelerated algorithms
- real-time signal processing
- high bandwidth IO
- low latency control
See the PYNQ webpage for an overview of the project, and find documentation on ReadTheDocs to get started.
The project currently supports multiple boards.
You can download a precompiled image, write the image to a micro SD card, and boot the board from the micro SD card.
See the Quickstart guide for details on writing the image to an SD card, and getting started with a PYNQ-enabled board.
Python Source Code
All Python code for the
pynq package can be found in the
/pynq folder. This folder can be found on the board after the board boots with the precompiled image.
To update your PYNQ SD card to the latest
pynq package, you can run the following command from a terminal connected to your board:
sudo pip3 install --upgrade --upgrade-strategy only-if-needed pynq
--upgrade-strategy only-if-needed option will upgrade dependencies only in case they do not satisfy the requirements, which will speed-up the installation process and also avoid possible upgrade errors.
SDK software projects and Python-C source codes are also stored along with the Python source code. After installing the
pynq package, the compiled target files will be saved automatically into the
Board Files and Overlays
All board related files including Vivado projects, bitstreams, and example notebooks, can be found in the
In Linux, you can rebuild the overlay by running make in the corresponding overlay folder (e.g.
/boards/Pynq-Z1/base). In Windows, you need to source the appropriate tcl files in the corresponding overlay folder.
Starting from PYNQ version
2.5.1, Alveo support has also been introduced. It is now possible to use PYNQ to tap into the potential of hardware acceleration in the data center space.
To get PYNQ on an Alveo-enabled system, simply install it through PIP:
pip install pynq
For Alveo cards, PYNQ currently requires a Xilinx Runtime (XRT) version above or equal to
2.3 to be installed in the system. In terms of Operating System, any XRT-supported version of either RedHat/CentOS or Ubuntu can be used.
For more information, please see the Alveo getting started guide.
Contributions to this repository are welcomed. Please refer to CONTRIBUTING.md for how to improve PYNQ.
Please ask questions on the PYNQ support forum.
PYNQ License: BSD 3-Clause License
Xilinx Embedded SW License: Multiple License File
Digilent IP License: MIT License
SDBuild Open Source Components
License and Copyrights Info TAR/GZIP
Open Components Source Code TAR/GZIP