True-Q™ Logo
2.9.2

Contents:

  • Welcome to True-Q™
  • Readme
    • Installation
      • Requirements
      • Optional dependencies
      • Updates
    • Citation
    • Documentation
      • Generating documentation
    • Testing
    • Troubleshooting
  • User Guide
    • Circuits
      • Operations
        • Gates
        • NativeGate
        • Measurements
        • Preparations
      • Cycles
      • Results
      • Circuits
      • Examples
    • Introduction to Protocols
      • Inspecting Generated Circuits
    • Collections and Metadata
      • Keys
      • Special Keywords
      • KeySets
      • Circuit Collections
      • Accessing Estimates and Circuits
      • Circuit Collection Internals
      • EstimateCollection Internals
    • Saving Objects
      • Examples
    • Protocols
      • Streamlined Randomized Benchmarking (SRB)
        • Estimated Parameters
        • Examples
      • Interleaved Randomized Benchmarking (IRB)
        • Estimated Parameters
        • Examples
      • Extended Randomized Benchmarking (XRB)
        • Estimated Parameters
        • Examples
      • Cycle Benchmarking (CB)
        • Estimated Parameters
        • Examples
      • K-body Noise Reconstruction (KNR)
        • Estimated Parameters
        • Examples
      • Stochastic Calibration (SC)
        • Estimated Parameters
        • Examples
      • Readout Calibration (RCAL)
        • Examples
      • Crosstalk Diagnostics (CTD)
        • Examples
      • Quantum Capacity (QCAP)
        • Estimated Parameters
        • Examples
    • Compilation Tools
      • Randomized Compiling (RC)
        • Examples
      • Configuration
        • Specifying Gates
        • Sample Config File
        • Examples
      • Converting and Running Circuits on Third-Party Platforms
        • Examples
      • Compiler
        • How it Works
        • Examples
    • Running Circuits
      • Simulator
        • Noise Models
        • Conditional Noise
        • Advanced Note
        • Examples
      • Executing Circuits on Qiskit Backends
        • Examples
  • Examples
    • Protocols
      • Cycle Benchmarking (CB)
        • Choosing Parameters
        • Benchmarking a Cycle
        • Targeting Specific Errors
      • Comparing Infidelities with SRB and XRB
      • Interleaved randomized benchmarking (IRB)
      • K-body Noise Reconstruction (KNR)
      • Extended Randomized Benchmarking (XRB)
        • Isolated XRB
        • Simultaneous XRB
      • Stochastic Calibration (SC)
      • Readout Calibration (RCAL)
        • Automatic Correction
      • Crosstalk Diagnostics
      • Streamlined Randomized Benchmarking (SRB)
        • Hello World
        • Isolated vs. Simultaneous SRB
        • Isolated SRB
        • Simultaneous SRB
        • Changing the Twirling Group Gateset
      • Quantum Capacity
    • Compilation Tools
      • Loading a Config
      • Randomized Compiling 1
      • Randomized Compiling 2
      • Gate synthesis
        • Synthesizing Single-Qubit Gates
        • Synthesizing Two-Qubit Gates
      • External Interfaces: Introduction
        • Cirq
        • PyQuil
        • Qiskit
        • Interface Config
      • Compiler: Converting to a Gateset
      • Defining Custom Compilers
        • Predefined Pass Lists
        • Custom Pass Lists
      • Phase Tracking with the Compiler
        • Using the Controlled-Z Gate
        • Using the Cross-Resonance Gate
        • Using the Molmer-Sorensen Gate
    • Simulation
      • Simulating Leakage
        • Kraus Noise
        • Measurement Classification
      • Simulator: Introduction
        • Simulator Basics
        • Adding Noise Sources
        • Restricting Noise via Conditional Noise Sources
      • Writing Custom Noise Sources
        • Caching
        • Wrappers and metadata
      • State Preparation and Measurement Noise
        • Adding Measurement Bitflip Noise
        • Adding Measurement POVM Noise
        • Adding State Preparation Noise
    • Utilities
      • Recording Results
      • Circuit Batching
        • Extra Circuits
      • Saving and Loading Objects to Disk
        • Reducing file size
        • Saving other objects
      • Running Jobs on Qiskit Backends
        • Submitting a Circuit Collection
        • Transpiling for a Specific Backend
  • API References
    • Circuits
      • Circuit
      • Circuit Collection
    • Compilation
      • CompilationError
      • Compiler
      • CompilePaulis
      • count_streaks
      • CycleReplacement
      • InvolvingRestrictions
      • Justify
      • MarkCycles
      • Merge
      • MarkerPass
      • Native1Q
      • Native1QRRZ
      • Native1QMode
      • Native2Q
      • Native2QCX
      • Native2QKAK
      • NativeDecomp
      • NativeExact
      • NCyclePass
      • OperationReplacement
      • Parallel
      • Pass
      • PhaseTrack
      • RCCycle
      • Relabel
      • RemoveEmptyCycle
      • RemoveId
      • TryInOrder
      • UnmarkCycles
      • compile
    • Config
      • Config
      • Gate Factory
      • Involving Rule
      • Parsing functions
      • Pre-Defined factories
    • Cycle
    • Estimate
      • Estimate (Parent Class)
      • Estimate Collection
      • Normal Estimates
      • Readout Estimates
      • Comp Table
      • KNR Data Table
    • Interfaces
      • Interface
      • Cirq
      • PyQuil
      • Qiskit
      • QASM
    • Keys
      • Key
      • KeySet
    • Math
      • Decomposition tools
      • Frame
      • General tools
      • KAK tools
      • Random Generators
      • Rotations
      • Superoperators
      • Tensors
    • Operations
      • Operation
      • Gate
      • Measurement
      • Native Gate
      • Preparation
    • Protocols
      • Make CB
      • Crosstalk Diagnostics
      • Make IRB
      • Make KNR
      • Make RCAL
      • Make SC
      • Make SRB
      • Make XRB
      • QCAP (Quantum Capacity)
      • Randomly Compile
    • Results
    • Sequencer
      • Batcher
      • Circuit Ruler
      • Circuit Sequencer
      • Consecutive
      • N Circuits
      • N Cycles
      • N Gates
      • NRC Riffler
      • RIFFLER
      • Total Time
    • Simulation
      • Simulator
      • CircuitPropagator
      • Match
      • NoiseSource
      • OpWrapper
      • CycleWrapper
    • Twirl
    • Utilities
    • Visualization
      • Graph
      • Multipy Lightness
      • Plot Mat
      • Compare
      • Compare Pauli Infidelities
      • Compare RB
      • Compare Twirl
      • IRB Summary
      • KNR Heatmap
      • Raw
      • PlottingSuite
      • Timestamps
  • Changelog
    • [2.9.2] - 2021-03-31
      • Added
      • Changed
      • Deprecated
      • Fixed
    • [2.9.1] - 2021-03-22
      • Added
      • Changed
      • Deprecated
      • Fixed
      • Removed
    • [2.9.0] - 2021-03-01
      • Added
      • Changed
      • Deprecated
      • Fixed
      • Removed
    • [2.8.6] - 2021-02-10
      • Added
      • Changed
      • Fixed
      • Removed
    • [2.8.5] - 2021-01-18
      • Added
      • Changed
      • Fixed
    • [2.8.4] - 2021-01-12
      • Added
      • Changed
      • Fixed
    • [2.8.3] - 2021-01-06
      • Fixed
    • [2.8.2] - 2021-01-05
      • Added
      • Changed
      • Fixed
    • [2.8.1] - 2020-12-09
      • Changed
      • Fixed
      • Removed
    • [2.8.0] - 2020-11-17
      • Added
      • Changed
      • Deprecated
      • Fixed
      • Removed
    • [2.7.6] - 2020-10-21
      • Added
      • Changed
      • Fixed
    • [2.7.5] - 2020-10-15
      • Added
      • Changed
      • Fixed
      • Removed
    • [2.7.4] - 2020-09-11
      • Added
      • Changed
      • Fixed
      • Removed
    • [2.7.3] - 2020-08-25
      • Added
      • Changed
    • [2.7.2] - 2020-08-18
      • Added
      • Changed
      • Fixed
    • [2.7.1] - 2020-08-07
      • Added
      • Changed
      • Fixed
    • [2.7.0] - 2020-07-23
      • Added
      • Changed
      • Fixed
      • Removed
    • [2.6.13] - 2020-06-05
      • Added
      • Fixed
      • Removed
    • [2.6.12] - 2020-05-08
      • Added
      • Changed
    • [2.6.11] - 2020-05-01
      • Added
      • Changed
      • Fixed
    • [2.6.10] - 2020-04-28
      • Added
    • [2.6.9] - 2020-04-13
      • Added
      • Fixed
    • [2.6.8] - 2020-04-09
      • Added
      • Fixed
    • [2.6.7] - 2020-04-06
      • Added
      • Changed
      • Fixed
    • [2.6.6] - 2020-03-27
      • Fixed
    • [2.6.5] - 2020-03-17
      • Added
      • Changed
    • [2.6.4] - 2020-03-09
      • Added
      • Changed
    • [2.6.3] - 2020-02-27
      • Fixed
    • [2.6.2] - 2020-02-26
      • Added
      • Changed
    • [2.6.1] - 2020-02-20
      • Changed
      • Fixed
    • [2.6.0] - 2020-02-14
      • Added
      • Changed
      • Fixed
    • [2.5.0] - 2020-02-11
      • Added
      • Changed
      • Fixed
    • [2.4.5] - 2020-02-06
      • Added
      • Fixed
    • [2.4.4] - 2020-02-05
      • Added
      • Fixed
    • [2.4.3] - 2020-02-04
      • Added
      • Fixed
    • [2.4.2] - 2020-02-04
      • Added
      • Changed
      • Fixed
      • Removed
    • [2.4.1] - 2020-01-23
      • Added
      • Changed
      • Fixed
    • [2.4.0] - 2020-01-17
      • Added
      • Changed
      • Fixed
    • [2.3.0] - 2019-12-10
      • Changed
      • Fixed
    • [2.2.3] - 2019-11-19
      • Changed
    • [2.2.2] - 2019-11-06
      • Added
    • [2.2.1] - 2019-11-01
      • Added
      • Changed
      • Fixed
    • [2.2.0] - 2019-10-21
      • Added
      • Changed
      • Fixed
      • Removed
  • Bibliography
True-Q™
  • »
  • API References
Next Previous

API References¶

  • Circuits
    • Circuit
    • Circuit Collection
  • Compilation
    • CompilationError
    • Compiler
    • CompilePaulis
    • count_streaks
    • CycleReplacement
    • InvolvingRestrictions
    • Justify
    • MarkCycles
    • Merge
    • MarkerPass
    • Native1Q
    • Native1QRRZ
    • Native1QMode
    • Native2Q
    • Native2QCX
    • Native2QKAK
    • NativeDecomp
    • NativeExact
    • NCyclePass
    • OperationReplacement
    • Parallel
    • Pass
    • PhaseTrack
    • RCCycle
    • Relabel
    • RemoveEmptyCycle
    • RemoveId
    • TryInOrder
    • UnmarkCycles
    • compile
  • Config
    • Config
    • Gate Factory
    • Involving Rule
    • Parsing functions
    • Pre-Defined factories
  • Cycle
  • Estimate
    • Estimate (Parent Class)
    • Estimate Collection
    • Normal Estimates
    • Readout Estimates
    • Comp Table
    • KNR Data Table
  • Interfaces
    • Interface
    • Cirq
    • PyQuil
    • Qiskit
    • QASM
  • Keys
    • Key
    • KeySet
  • Math
    • Decomposition tools
    • Frame
    • General tools
    • KAK tools
    • Random Generators
    • Rotations
    • Superoperators
    • Tensors
  • Operations
    • Operation
    • Gate
    • Measurement
    • Native Gate
    • Preparation
  • Protocols
    • Make CB
    • Crosstalk Diagnostics
    • Make IRB
    • Make KNR
    • Make RCAL
    • Make SC
    • Make SRB
    • Make XRB
    • QCAP (Quantum Capacity)
    • Randomly Compile
  • Results
  • Sequencer
    • Batcher
    • Circuit Ruler
    • Circuit Sequencer
    • Consecutive
    • N Circuits
    • N Cycles
    • N Gates
    • NRC Riffler
    • RIFFLER
    • Total Time
  • Simulation
    • Simulator
    • CircuitPropagator
    • Match
    • NoiseSource
    • OpWrapper
    • CycleWrapper
  • Twirl
  • Utilities
  • Visualization
    • Graph
    • Multipy Lightness
    • Plot Mat
    • Compare
    • Compare Pauli Infidelities
    • Compare RB
    • Compare Twirl
    • IRB Summary
    • KNR Heatmap
    • Raw
    • PlottingSuite
    • Timestamps

© Copyright 2021, Quantum Benchmark Inc.

Built with Sphinx, Sphinx-Gallery, Jupyter-Sphinx, and a theme based on Read the Docs.