Metadata-Version: 2.4
Name: pynq
Version: 4.0.0
Summary: (PY)thon productivity for zy(NQ)
Home-page: https://github.com/Xilinx/PYNQ
Download-URL: https://github.com/Xilinx/PYNQ
Author: Xilinx PYNQ Development Team
Author-email: pynq_support@xilinx.com
License: BSD 3-Clause
Requires-Python: >=3.5.2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pynqmetadata
Requires-Dist: pynqutils
Requires-Dist: setuptools>=24.2.0
Requires-Dist: cffi
Requires-Dist: pycparser<3
Requires-Dist: numpy<2.0
Requires-Dist: nest_asyncio
Requires-Dist: grpcio==1.64.0
Requires-Dist: grpcio-tools==1.64.0
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

![pynq_logo](https://github.com/Xilinx/PYNQ/raw/master/logo.png)

![python](https://github.com/Xilinx/PYNQ/workflows/Python/badge.svg)

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 <a href="http://www.pynq.io/" target="_blank">PYNQ webpage</a> for an
overview of the project, and find
<a href="http://pynq.readthedocs.io" target="_blank">documentation on ReadTheDocs</a>
to get started.

## Precompiled Image

The project currently supports <a href="https://www.pynq.io/boards.html" target="_blank">multiple boards</a>.

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 <a href="http://pynq.readthedocs.io/en/latest/getting_started.html" target="_blank">Quickstart guide</a> 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:

```console
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](sdbuild/README.md) and
[sdbuild/BUILD_SYSTEM.md](sdbuild/BUILD_SYSTEM.md) for the image and board
porting flows, and the
<a href="http://pynq.readthedocs.io/en/latest/pynq_sd_card.html" target="_blank">PYNQ SD card documentation</a>.

## Contribute

Contributions to this repository are welcomed. Please refer to <a href="https://github.com/Xilinx/PYNQ/blob/master/CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a> 
for how to improve PYNQ.

## Support

Please ask questions on the <a href="https://discuss.pynq.io" target="_blank">PYNQ support forum</a>.

## Citing PYNQ

If you use PYNQ in your research, please cite this GitHub repository by using the metadata given in <a href="https://github.com/Xilinx/PYNQ/blob/master/CITATION.cff" target="_blank">CITATION.cff</a>.

## Licenses

**PYNQ** License: [BSD 3-Clause License](https://github.com/Xilinx/PYNQ/blob/master/LICENSE)

**Xilinx Embedded SW** License: [Multiple License File](https://github.com/Xilinx/embeddedsw/blob/master/license.txt)

**Digilent IP** License: [MIT License](https://github.com/Xilinx/PYNQ/blob/master/THIRD_PARTY_LIC)

## SDBuild Open Source Components

**License and Copyrights Info** [TAR/GZIP](https://www.xilinx.com/bin/public/openDownload?filename=pynq-v4.0.0-license.tar.gz)

**Open Components Source Code** [TAR/GZIP](https://www.xilinx.com/bin/public/openDownload?filename=pynq-v4.0.0-open_components.tar.gz)
