Welcome to the docs for pyQuil!

As a part of the Quil SDK, pyQuil allows you to build and execute Quil programs using Python. pyQuil requires installation of the other components of the Quil SDK, namely the Quil compiler (quilc) and the Quantum Virtual Machine (QVM), used for simulating quantum computers. You can also use pyQuil to run programs on real quantum computers using Rigetti’s Quantum Cloud Services (QCS).

To learn more about Quil, the Quil SDK, and QCS, see Rigetti’s documentation.

If you’re new to pyQuil, head to the getting started guide to get setup and run your first program!

Note

If you’ve used pyQuil before, be sure to check out Introducing pyQuil v4 to help get oriented on the key changes in v4.

Contents

• Getting started
  • Pre-requisites
  • Run your first program
• Programs and gates
  • Introduction
  • The standard gate set
  • Declaring memory
  • Measurement
  • Parametric compilation
  • Gate modifiers
  • Defining new gates
  • Defining parametric gates
  • Defining permutation gates
  • Pragmas
  • Asking for a delay
  • Ways to construct programs
• The quantum computer
  • The Quantum Virtual Machine (QVM)
  • The Quantum Processing Unit (QPU)
  • The QuantumComputer
  • Simulating the QPU using the QVM
• The wavefunction simulator
  • Multi-qubit basis enumeration
• The Quil compiler
  • Expectations for program contents
  • Interacting with the compiler
  • Region-specific compiler features through PRAGMA commands
  • Rewirings
  • Common Error Messages
• Noise and quantum computation
  • Modeling noisy quantum gates
  • Noisy gates on the QVM
  • Getting started
  • Example 1: Amplitude damping
  • Example 2: Dephased CZ-gate
  • Adding Decoherence Noise
  • Modeling readout noise
  • Working with readout noise
• Advanced usage
  • pyQuil configuration
  • Multithreading
  • Alternative QPU endpoints
  • Using libquil for Quilc and QVM
  • Using qubit placeholders
  • Classical control flow
  • Pauli Operator Algebra
• Troubleshooting
  • Timeout in compilation
  • Timeout in execution
  • Collect debug information
• Introducing pyQuil v4
  • Parameters & memory
  • QCS Gateway and execution options
  • Accessing raw execution data
• Exercises
  • Exercise 1: Quantum Dice
  • Exercise 2: Controlled Gates
  • Exercise 3: Grover’s Algorithm
  • Exercise 4: Prisoner’s Dilemma
  • Exercise 5: Quantum Fourier Transform
  • Example: The Meyer-Penny Game
• Changelog
  • 4.14.3 (2024-09-24)
  • 4.14.3-rc.0 (2024-09-24)
  • 4.14.2 (2024-08-20)
  • 4.14.2-rc.0 (2024-08-20)
  • 4.14.1 (2024-08-13)
  • 4.14.1-rc.1 (2024-08-13)
  • 4.14.1-rc.0 (2024-08-13)
  • 4.14.0 (2024-07-30)
  • 4.14.0-rc.0 (2024-07-30)
  • 4.13.1 (2024-07-25)
  • 4.13.1-rc.0 (2024-07-25)
  • 4.13.0 (2024-07-16)
  • 4.13.0-rc.0 (2024-07-15)
  • 4.12.0 (2024-07-03)
  • 4.12.0-rc.0 (2024-07-02)
  • 4.11.0 (2024-06-05)
  • 4.11.0-rc.0 (2024-06-05)
  • 4.10.1 (2024-05-10)
  • 4.10.1-rc.0 (2024-05-10)
  • 4.10.0 (2024-04-29)
  • 4.10.0-rc.0 (2024-04-29)
  • 4.9.2 (2024-04-17)
  • 4.9.2-rc.0 (2024-04-17)
  • 4.9.1 (2024-04-16)
  • 4.9.1-rc.0 (2024-04-16)
  • 4.9.0 (2024-04-15)
  • 4.9.0-rc.3 (2024-04-12)
  • 4.9.0-rc.2 (2024-04-11)
  • 4.9.0-rc.1 (2024-04-10)
  • 4.9.0-rc.0 (2024-04-09)
  • 4.8.0 (2024-03-08)
  • 4.8.0-rc.0 (2024-03-08)
  • 4.7.0 (2024-02-27)
  • 4.7.0-rc.2 (2024-02-27)
  • 4.7.0-rc.1 (2024-02-22)
  • 4.7.0-rc.0 (2024-02-22)
  • 4.6.2 (2024-02-20)
  • 4.6.2-rc.3 (2024-02-16)
  • 4.6.2-rc.2 (2024-02-16)
  • 4.6.2-rc.1 (2024-02-13)
  • 4.6.2-rc.0 (2024-02-07)
  • 4.6.1 (2024-02-06)
  • 4.6.1-rc.2 (2024-02-06)
  • 4.6.1-rc.1 (2024-02-06)
  • 4.6.1-rc.0 (2024-02-05)
  • 4.6.0 (2024-02-01)
  • 4.6.0-rc.4 (2024-02-01)
  • 4.6.0-rc.3 (2024-01-30)
  • 4.6.0-rc.2 (2024-01-27)
  • 4.6.0-rc.1 (2024-01-27)
  • 4.6.0-rc.0 (2024-01-26)
  • 4.5.0 (2024-01-24)
  • 4.5.0-rc.0 (2024-01-18)
  • 4.4.1-rc.0 (2024-01-16)
  • 4.4.0 (2023-12-15)
  • 4.4.0-rc.1 (2023-12-15)
  • 4.4.0-rc.0 (2023-12-15)
  • 4.3.1-rc.1 (2023-12-15)
  • 4.3.1-rc.0 (2023-12-14)
  • 4.3.0 (2023-12-08)
  • 4.3.0-rc.1 (2023-12-08)
  • 4.3.0-rc.0 (2023-12-06)
  • 4.2.0 (2023-11-28)
  • 4.2.0-rc.1 (2023-11-28)
  • 4.2.0-rc.0 (2023-11-28)
  • 4.1.1 (2023-11-15)
  • 4.1.1-rc.0 (2023-11-15)
  • 4.1.0 (2023-11-13)
  • 4.1.0-rc.5 (2023-11-13)
  • 4.1.0-rc.4 (2023-11-09)
  • 4.1.0-rc.3 (2023-11-07)
  • 4.1.0-rc.2 (2023-11-01)
  • 4.1.0-rc.1 (2023-10-31)
  • 4.1.0-rc.0 (2023-10-27)
  • 4.0.3 (2023-10-18)
  • 4.0.3-rc.0 (2023-10-18)
  • 4.0.2 (2023-10-16)
  • 4.0.2-rc.0 (2023-10-16)
  • 4.0.1 (2023-09-27)
  • 4.0.1-rc.0 (2023-09-27)
  • 4.0.0
  • 3.5.4
  • 3.5.3
  • 3.5.2
  • 3.5.1
  • 3.5.0
  • 3.5.0-rc.0
  • 3.4.1
  • 3.4.0
  • 3.3.5
  • 3.3.4
  • 3.3.3
  • 3.3.2
  • 3.3.1
  • 3.3.0
  • 3.3.0-rc.0
  • v3.2.0
  • v3.1.0
  • v3.0.1
  • v3.1.0
  • v3.0.1
  • v3.0.0
  • v2.28.2 (July 6, 2021)
  • v2.28.1 (May 5, 2021)
  • v2.28.0 (January 26, 2021)
  • v2.27.0 (December 30, 2020)
  • v2.26.0 (December 10, 2020)
  • v2.25.0 (November 17, 2020)
  • v2.24.0 (November 5, 2020)
  • v2.23.1 (September 9, 2020)
  • v2.23.0 (September 7, 2020)
  • v2.22.0 (August 3, 2020)
  • v2.21.1 (July 15, 2020)
  • v2.21.0 (July 14, 2020)
  • v2.20 (June 5, 2020)
  • v2.19 (March 26, 2020)
  • v2.18 (March 3, 2020)
  • v2.17 (January 30, 2020)
  • v2.16 (January 10, 2020)
  • v2.15 (December 20, 2019)
  • v2.14 (November 25, 2019)
  • v2.13 (November 7, 2019)
  • v2.12 (September 28, 2019)
  • v2.11 (September 3, 2019)
  • v2.10 (July 31, 2019)
  • v2.9.1 (June 28, 2019)
  • v2.9 (June 25, 2019)
  • v2.8 (May 20, 2019)
  • v2.7.2 (May 3, 2019)
  • v2.7.1 (April 30, 2019)
  • v2.7 (April 29, 2019)
  • v2.6 (March 29, 2019)
  • v2.5 (March 6, 2019)
  • v2.4 (February 14, 2019)
  • v2.3 (January 28, 2019)
  • v2.2 (January 4, 2019)
  • v2.1 (November 30, 2018)
  • v2.0 (November 1, 2018)
  • v1.9 (June 6, 2018)

Quil-T

• Quil-T
• Getting up and running with Quil-T
  • Language Documentation
  • Construct a QuantumComputer object linked to the Quil-T compiler
  • Get Quil-T Calibrations
  • Compiling and running a Quil-T Program
• Pulses and waveforms
  • Waveform Templates and References
  • A Catalog of Template Waveforms
  • Capture and Kernels
  • Compile Time versus Run Time
• Parametric compilation examples
  • Qubit Spectroscopy
  • Power Rabi
  • Time Rabi
• Accessing raw measurement data with RAW-CAPTURE
  • Peeking at a MEASURE calibration
  • RAW-CAPTURE experiments
  • Some Restrictions May Apply

API Reference

• pyquil

Indices and tables

• Index

• Module Index

• Search Page