qasmparse

Documentation

Overview

Package qasmparse parses OpenQASM 3.0 with OpenPulse cal {} blocks into pulse.Program objects. It is the inverse of the QASM emission performed by the Braket backend serializer.

The parser handles the subset of OpenQASM used for pulse-level control: port declarations, frame definitions, and all eight pulse instruction types (play, delay, set_phase, shift_phase, set_frequency, shift_frequency, barrier, capture_v0).

Usage:

prog, err := qasmparse.ParseString(qasmSource)
if err != nil {
    log.Fatal(err)
}
// prog is a *pulse.Program

Waveform constructor calls (e.g., gaussian(0.5, 2e-08, 1e-08)) are resolved against built-in waveforms from the waveform package. Custom waveforms can be registered via WithWaveform.

Index

• func Parse(r io.Reader, opts ...Option) (*pulse.Program, error)
• func ParseString(source string, opts ...Option) (*pulse.Program, error)
• type Option
  • func WithDefaultDt(dt float64) Option
  • func WithWaveform(name string, fn WaveformConstructor) Option
• type WaveformConstructor

Functions

func Parse

func Parse(r io.Reader, opts ...Option) (*pulse.Program, error)

Parse reads OpenPulse QASM from r and returns a pulse Program.

func ParseString

func ParseString(source string, opts ...Option) (*pulse.Program, error)

ParseString parses OpenPulse QASM source text into a pulse Program.

Types

type Option

type Option func(*config)

Option configures the parser.

func WithDefaultDt

func WithDefaultDt(dt float64) Option

WithDefaultDt sets the port time resolution (default 1e-9 = 1ns).

func WithWaveform

func WithWaveform(name string, fn WaveformConstructor) Option

WithWaveform registers a custom waveform constructor by name.

type WaveformConstructor

type WaveformConstructor func(args []float64) (pulse.Waveform, error)

WaveformConstructor builds a waveform from numeric arguments.