Carlisle - v3.1.2 bugfix release

This patch release resolves an issue in setup.py that affected dependency resolution when installing from PyPI. In particular, it fixes compatibility when installing PYNQ on host machines for use with PYNQ.remote.

No new SD card images are provided for this release, as the changes only affect host-side installation.

Carlisle - v3.1.1 bugfix release

This patch release fixes a few bugs and includes a few quality of life additions.

Bugs fixed:

• DMAs set with 32bit address widths would be given 64-bit addresses.
• PYNQ's global state file cache was not updating in some circumstances
• pyxrt.close() was returning error

Quality-of-life:

• PYNQ.remote now uses local cache for RemoteBuffer, vastly improving usability
• PYNQ now has a CITATION.cff file. If you use PYNQ in your research please cite this repo using the metadata in this file.
• The PYNQ SDIST is now able to be built within the SD build Docker container.

New sdcards are available at www.pynq.io/boards or v3.1.1 updates can be installed on existing SD Cards by running the pip command below from within a Jupyter session.

pip install --upgrade pynq --no-build-isolation

Carlisle Release

This GitHub tag is tied to the release of the following SDCard images on pynq.io/boards:

PYNQ-Z1 v3.1 SDCard image
PYNQ-Z2 v3.1 SDCard image
ZCU104 v3.1 SDCard image
PYNQ-ZU v3.1 SDCard image (Coming soon)
RFSoC4x2 v3.1 SDCard image (Coming soon)
ZCU208 v3.1 SDCard image (Coming soon)

Within those image files, PYNQ v3.1 is already installed. Updates to PYNQ since the last release include:

• Upgraded Software

  • All overlays built with Vivado 2024.1
  • Linux kernel and build updated to Petalinux 2024.1

• Productivity additions

  • Beta release of PYNQ.remote
  • Beta release of PYNQ.cpp

• SD Build updates

  • Docker flow for building PYNQ images
  • Added pynqremote target to SD Build Makefile for building PYNQ.remote images.

• Deprecations

  • Support for Alveo platforms is deprecated
  • Removed Vagrant VM support for SD card image builds (replaced with Docker flow)

Belfast - bugfix release

This patch release fixes an overlay unload error we observed as new overlays were tested.

New sdcards are available at www.pynq.io/board or v3.0.1 updates can be installed on existing SD Cards by running the pip command below from within a Jupyter session.

pip install --upgrade pynq --no-build-isolation

Belfast Release

This github tag is tied to the release of the following SDCard images on pynq.io/board:

PYNQ-Z1 v3.0.0 SDCard image
PYNQ-Z2 v3.0.0 SDCard image
PYNQ-ZU v3.0.0 SDCard image
ZCU104 v3.0.0 SDCard image
RFSoC2x2 v3.0.0 SDCard image
RFSoC4x2 v3.0.0 SDCard image
ZCU111 v3.0.0 SDCard image
(new) ZCU208 v3.0.0 SDCard image

Within those image files, PYNQ v3.0.0 is already installed. Updates to PYNQ since the last release include:

• Official Ubuntu 22.04 support on the Kria-PYNQ repository:

  • KV260
  • (new) KR260

• Upgraded Software

  • All overlays built with Vivado 2022.1
  • Linux kernel and build updated to Petalinux 2022.1

• Productivity additions - software

  • Updated to Python 3.10
  • Updated to JupyterLab 3.4.4
  • Updated to Ubuntu 22.04 based packages
  • Separation of PYNQ-Utils repository for overlay packaging

• Productivity additions - hardware

  • Added XSA parsing support
  • Added debug bridge IP for XVC server support
  • Improved support for block design containers and partial reconfiguration
  • Separation of PYNQ-Metadata repository for design exploration

• SD Build updates

  • API change to emphasize builds using prebuilt root filesystem
  • API change to emphasize builds using PYNQ source distribution
  • XRT library included in board-agnostic images

• Deprecations

  • PL server as a multi-user daemon is deprecated - pynq server CLI is also deprecated
  • 3rd party board automatic building of overlays in SD Build is deprecated
  • Wavedrom viewing in JupyterLabs is deprecated - Jupyter notebook viewing is still supported
  • Use of pynq/utils.py will be deprecated in future releases - PYNQ-Utils will have same APIs
  • Use of pynq/pl_server/.py will be deprecated in future releases - PYNQ-Metadata will have same APIs

Austin Release

This github tag is tied to the release of the following SDCard images on pynq.io/board:

PYNQ-Z1 v2.7.0 SDCard image
PYNQ-Z2 v2.7.0 SDCard image
PYNQ-ZU v2.7.0 SDCard image
RFSoC2x2 v2.7.0 SDCard image
ZCU104 v2.7.0 SDCard image
ZCU111 v2.7.0 SDCard image

Within those image files, PYNQ v2.7.0 is already installed. Updates to PYNQ since the last release include:

• Upgraded Software

  • All overlays built with Vivado 2020.2
  • Linux kernel and build updated to Petalinux 2020.2

• Productivity additions

  • Updated to Python 3.8
  • Updated to JupyterLab 3.0.16
  • Updated to Ubuntu 20.04 based packages
  • Pynq and Jupyter now execute in a virtual environment (venv)

• SD Build updates

  • Updated to use OpenEmbedded WIC flows for building SD card images

• Programmable Logic updates

  • Added cmac.py for 100 GbE offload
  • PL DRAM allocation support added
  • RFSoC clock and data converters updated to support RFSoC Gen3 devices

• Deprecations

  • Removed Xlnk allocator and libraries for edge devices (replaced by XRT allocation)

WFH - Read the Docs

This is a minor release to incorporate v2.6.0 documentation updates.

WFH Release

This github tag is tied to the release of the following SDCard images on pynq.io/board:

PYNQ-Z1 v2.6.0 SDCard image
PYNQ-Z2 v2.6.0 SDCard image
ZCU104 v2.6.0 SDCard image
ZCU111 v2.6.0 SDCard image

Within those image files, PYNQ v2.6.0 is already installed. Updates to PYNQ since the last release include:

• Upgraded Software

  • All overlays built with Vivado 2020.1
  • Linux kernel and build updated to Petalinux 2020.1

• Productivity Additions

  • Docker support enabled in the kernel config
  • Pybind11 support and notebook added for C++ integration
  • Support for BOOT.BIN bitstream inclusion for custom sdcard builds
  • Boot.py added to boot partition to enable modifications to the PYNQ boot flow

• Deprecations

  • Removed Xlnk allocator from all notebooks - please now use pynq.allocate
  • Tcl parsing removed - please generate and use an HWH file for Overlays

Bespin Release

This github tag is tied to the release of PYNQ Support for Alveo platforms and AWS F1 instances.

• Alveo and AWS F1 Support

  • Alveo platforms and AWS F1 instances are now supported
  • IP dictionary and Overlay classes support xclbin metadata parsing
  • Live Alveo power monitoring added
  • Vitis kernel signatures delivered with loaded xlcbin files
  • AWS F1 awsxclbin files are supported

• Productivity Additions

  • PYNQ is now on PYPI and can be installed using pip install pynq
  • PYNQ can be installed on x86 machines to support attached Alveo platforms or AWS F1 instances
  • pynq.utils added for dependent packages to install notebooks and bitstreams
  • pynq._cli added for new commandline calls to collect and deliver notebooks
  • JupyterLab views of bitstream metadata dictionaries added

• SD Build Updates

  • Support added for building sdcard images from Ubuntu 18.04 host machines

• No new SD Card images were created for this release

Glasgow Release

This github tag is tied to the release of the following SDCard images:

PYNQ-Z1 v2.5 SDCard image
PYNQ-Z2 v2.5 SDCard image
ZCU104 v2.5 SDCard image
ZCU111 v2.5 SDCard image

Within those image files, PYNQ v2.5 is already installed. Updates to PYNQ since the last release include:

• Productivity Additions

  • Updated to JupyterLab 1.1.3
  • JupyterLab extensions support added
  • Support for multiple memories using mem_dict entries
  • Support for Device Tree Overlays delivered with PL overlays
  • Support for custom PL device communication using the Device metaclass

• Programmable Logic Updates

  • All bitstreams built using Vivado 2019.1
  • XRT Support added (beta)

• Repository Updates

  • Jenkins CI added
  • Sdist support added (removing all binaries from the repository)

• SDBuild Updates

  • Boot partition built on Petalinux 2019.1