Public API

Compilation

The translation plugin and the transpiler pass compile circuits for a Qiskit Target. A GulpsDecomposer compiles one two-qubit target, and a pass built from it uses its gates on every pair.

decomposition.GulpsDecomposer	Synthesizes a two-qubit unitary exactly, as the sequence of the given gates with the least total cost.
transpiler.GulpsTranslationPlugin	Use GULPS for Qiskit's translation stage with translation_method="gulps".
transpiler.GulpsDecompositionPass	Replace each two-qubit block of a DAG with a GULPS circuit.

Gate invariants

invariants.LocalEquivalenceClass

The local-equivalence class of a two-qubit gate.

Instruction-set analysis

These objects measure the reachable regions, Haar coverage, and cost of an instruction set, and choose calibrated strengths, without synthesizing circuits.

analysis.region.haar_mass	Haar mass of the union of regions, by inclusion-exclusion.
analysis.coverage.coverage_report	Integrate Haar coverage and average cost of a fixed ISA.
analysis.coverage.empirical_cost	Select a sentence for every target and summarize the costs.
analysis.calibration.calibrate	Choose up to budget powers of base_gate from strengths.
analysis.calibration.strength_sweep	Score base_gate ** k for every k in strengths.

analysis.coverage.CoverageReport	Haar coverage and cost of a fixed ISA, integrated in floating point.
analysis.coverage.SentenceCoverage	A gate sentence, its reachable region, and its newly covered Haar mass.
analysis.coverage.SampledCost	Costs of the selected sentences over a finite target sample.
analysis.calibration.Calibration	Strengths and scores returned by calibrate().
analysis.calibration.StrengthSweep	The score of every single strength on a grid.
analysis.region.ReachableRegion	One orientation of the local-equivalence classes a gate sentence reaches.

Visualization

These functions require the gulps[viz] extra.

analysis.viz.weyl_chamber.draw_chamber	Draw the Weyl chamber wireframe and the perfect-entangler polyhedron on 3-D axes.
analysis.viz.invariant_viz.scatter_plot	Scatter plot of a list of LocalEquivalenceClass in the Weyl chamber.
analysis.viz.polytope_viz.plot_region	Plot both orientations of a ReachableRegion in the Weyl chamber.
analysis.viz.polytope_viz.plot_coverage_set	Show each coverage entry in its own Weyl-chamber subplot.
analysis.viz.polytope_viz.plot_waypoints	Draw each backward waypoint selection of a compiled target in its own Weyl chamber.

Errors

decomposition.DecompositionError	A target could not be selected or synthesized, or a gate's class could not be computed.
decomposition.SearchDepthError	No sentence within max_depth reaches the target.