Python Productivity for ZYNQ
Jupyter Notebook C C++ Python Tcl Verilog Other

README.md

alt tag

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.

Precompiled Image

The project currently supports the PYNQ-Z1 board.

You can download the 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 the PYNQ-Z1 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.6 install --upgrade git+https://github.com/Xilinx/PYNQ.git

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/Pynq-Z1/base). In Windows, you need to source the appropriate tcl files in the corresponding overlay folder.

Contribute

Contributions to this repository are welcomed. To submit a project for inclusion:

  1. Fork this repository to your own github account using the fork button above.

  2. Clone (download) the fork to a local computer using git clone.

  3. You can modify the Vivado project, bitstream, SDK project, Python source code, or notebook in the corresponding folders.

  4. Modify the documentation if necessary.

  5. Use git add-->git commit-->git push to add changes to your fork.

  6. Then submit a pull request by clicking the pull request button on your github repo.

Check the guide to git for more information.

Support

Please ask questions on the PYNQ support forum.