pynq 4.0.0

PYNQ is an open-source project from AMD that makes it easy to design embedded systems with AMD adaptive SoCs. Using the Python language and libraries, designers can exploit the benefits of programmable logic and processors to build more capable embedded systems.

PYNQ users can 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.

Precompiled Image

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.

Quick Start

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

The --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 pynq package.

Board Files and Overlays

All board related files including Vivado projects, bitstreams, and example notebooks, can be found in the /boards folder.

In Linux, you can rebuild the overlay by running make in the corresponding overlay folder (e.g. /boards/ZCU104/base). In Windows, you need to source the appropriate tcl files in the corresponding overlay folder.

Building SD Card Images

SD card images are built from sdbuild/ using Docker. See sdbuild/README.md and sdbuild/BUILD_SYSTEM.md for the image and board porting flows, and the PYNQ SD card documentation.

Contribute

Contributions to this repository are welcomed. Please refer to CONTRIBUTING.md for how to improve PYNQ.

Support

Please ask questions on the PYNQ support forum.

Citing PYNQ

If you use PYNQ in your research, please cite this GitHub repository by using the metadata given in CITATION.cff.

Licenses

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