1. Installation

1.1. Preparing the hardware

For PyRPL to work, you need a working Red Pitaya / STEMlab connected to the same local area network (LAN) as the computer running PyRPL. If you have not already set up your Red Pitaya, follow the current official Red Pitaya quick-start documentation and make sure you can reach the board from your computer.

Hardware installation for PyRPL gives more detailed instructions in case you are experiencing any trouble.

1.2. Installing PyRPL

The easiest and fastest way to get PyRPL running is to download and execute the latest precompiled executable from the PyRPL releases page.

If you prefer an installation from source code, go to Running the Python source code.

Warning

Do not use pip install pyrpl. The package on PyPI is outdated. Use the GitHub-based installation documented in Installing PyRPL.

1.3. Compiling the FPGA code (optional)

A ready-to-use FPGA bitfile comes with PyRPL. If you want to build your own, possibly customized bitfile, go to Building the FPGA firmware.