getting_started.rst

Getting Started

You need a supported AMD-Xilinx platform to get started. How you get PYNQ depends on your platform. For some Zynq|Zynq Ultrascale+ platforms you can download an SD card image to boot the board. For other platforms, including Alveo and Kria SoMs, you can install PYNQ onto your host Operating System.

If you have one of the following boards, you can follow the quick start guide. Go to the PYNQ support forum for help.

Zynq, Zynq Ultrascale+ and Zynq RFSoC

.. toctree::
    :maxdepth: 1

    getting_started/pynq_z1_setup.rst
    getting_started/pynq_z2_setup.rst
    getting_started/zcu104_setup.rst

• Ultra96
• PYNQ-ZU

• RFSoC-PYNQ

Kria SoMs

• Kria-PYNQ

Alveo and XRT supported platforms

.. toctree::
    :maxdepth: 1

    getting_started/alveo_getting_started.rst
    getting_started/pynq_alveo

Jupyter Introduction

If you are new to Jupyter, you can follow the introductory tutorials:

.. toctree::
    :maxdepth: 1

    getting_started/python_environment
    getting_started/jupyter_notebooks
    getting_started/jupyter_notebooks_advanced_features

Example overlays and notebooks

You can find a selection of PYNQ projects and notebooks on the PYNQ community webpage. These are projects from other PYNQ users that you can install and use on your own PYNQ platform (assuming the design supports your platform).

You can also install additional overlays and notebooks using the PYNQ command line interface:

.. toctree::
    :maxdepth: 1

    pynq_cli

Using PYNQ with other boards

You can find other PYNQ enabled boards on the PYNQ.io boards page.

If you have another Xilinx-based platform you would like to use with PYNQ, see the following guide:

.. toctree::
    :maxdepth: 1

    getting_started/other_boards.rst