API References
- Algorithms
- Circuits
- Circuit
CircuitCircuit.copy()Circuit.measure_all()Circuit.dimCircuit.keyCircuit.n_sysCircuit.labelsCircuit.n_cyclesCircuit.cyclesCircuit.resultsCircuit.has_resultsCircuit.append()Circuit.prepend()Circuit.meas_locsCircuit.n_measCircuit.draw()Circuit.get_probability()Circuit.same_structure()Circuit.to_dict()Circuit.from_dict()Circuit.to_cirq()Circuit.to_pyquil()Circuit.to_qasm()Circuit.to_qiskit()
- Circuit Collection
CircuitCollectionCircuitCollection.dimCircuitCollection.n_circuitsCircuitCollection.n_sysCircuitCollection.labelsCircuitCollection.append()CircuitCollection.shuffle()CircuitCollection.n_resultsCircuitCollection.has_no_resultsCircuitCollection.has_some_resultsCircuitCollection.has_all_resultsCircuitCollection.save()CircuitCollection.fit()CircuitCollection.plotCircuitCollection.batch()CircuitCollection.copy()CircuitCollection.keys()CircuitCollection.similar_keys()CircuitCollection.update_keys()CircuitCollection.subset()CircuitCollection.to_dict_list()CircuitCollection.from_dict_list()CircuitCollection.batch_size()CircuitCollection.resultsCircuitCollection.sum_results()
- Circuit
- Compilation
- Base Classes
- Decomposition Strategy
- AllocateLabels
- CompilePaulis
- CycleReplacement
- DeferredSwapper
- InvolvingRestrictions
- Justify
- MarkBlocks
- MarkCycles
- Merge
- Native1Q
- Native1QRRZ
- Native1QMode
- Native2Q
- Native2QCX
- Native2QKAK
- NativeDecomp
- NativeExact
- OneQuditDecomp
- Parallel
- PhaseTrack
- RCCycle
- RCKak
- RCLocal
- Relabel
- RemarkCycles
- RemoveEmptyCycle
- RemoveId
- TryInOrder
- UnmarkCycles
- Helper Functions
- Config
- Config
- Gate Factory
GateFactoryGateFactory.layersGateFactory.from_function()GateFactory.from_matrix()GateFactory.from_hamiltonian()GateFactory.embed_layers()GateFactory.subset()GateFactory.fix_parameters()GateFactory.pauli_constGateFactory.pauli_angleGateFactory.make_gate()GateFactory.check_subspace()GateFactory.n_sysGateFactory.dimGateFactory.widthGateFactory.parametersGateFactory.free_parametersGateFactory.n_paramsGateFactory.fixed_parametersGateFactory.involvingGateFactory.to_dict()GateFactory.from_dict()GateFactory.is_u1GateFactory.is_u2GateFactory.is_u3GateFactory.is_r
- Involving Rule
- Parsing functions
- Pre-Defined factories
- Cycle
CycleCycle.dimCycle.labelsCycle.n_gatesCycle.n_measCycle.n_prepCycle.n_operationsCycle.n_sysCycle.gatesCycle.gates_singleCycle.gates_multiCycle.gate_labelsCycle.prepCycle.prep_labelsCycle.measCycle.meas_labelsCycle.operationsCycle.contained_gates()Cycle.tensor()Cycle.is_equivalent()Cycle.same_structure()Cycle.to_dict()Cycle.from_dict()Cycle.marker
- Estimate
- Estimate (Parent Class)
- Estimate Collection
- Estimate Array
- Normal Estimates
- Readout Estimates
- Comparison Table
- KNR Specializations
- Exceptions
- Interfaces
cirqpyquilExecutorQASMqiskitMetadataPyQuilMetadataCirqMetadataQiskitMetadata- Interface
- Cirq
- PyQuil
PyQuilInterfacePyQuilInterface.set_config()PyQuilInterface.to_trueq_circ()PyQuilInterface.pair_from_trueq_circ()PyQuilInterface.from_trueq_circ()PyQuilInterface.defgate_to_factory()PyQuilInterface.to_trueq_gate()PyQuilInterface.from_trueq_gate()PyQuilInterface.default_config()PyQuilInterface.config_from_isa()PyQuilInterface.set_from_isa()
- Qiskit
QiskitInterfaceQiskitInterface.set_config()QiskitInterface.to_trueq_circ()QiskitInterface.pair_from_trueq_circ()QiskitInterface.from_trueq_circ()QiskitInterface.to_trueq_gate()QiskitInterface.from_trueq_gate()QiskitInterface.default_config()QiskitInterface.qiskit_dag_to_tq_circ()QiskitInterface.set_from_backend()QiskitInterface.config_from_backend()
- QASM
- Keys
- Math
- Decomposition tools
- General tools
- KAK tools
- Random Generators
- Rotations
- Superoperators
SuperopSuperop.dimSuperop.n_sysSuperop.total_dimSuperop.choi_rankSuperop.is_cpSuperop.is_cptpSuperop.is_tpSuperop.is_unitalSuperop.is_unitarySuperop.adjSuperop.avg_gate_fidelitySuperop.avg_gate_infidelitySuperop.coherent_infidelitySuperop.dnormSuperop.fidelitySuperop.infidelitySuperop.norm()Superop.stochastic_infidelitySuperop.unitary_fractionSuperop.unitaritySuperop.depolarizing()Superop.eye()Superop.random_bcsz()Superop.random_constrained_cptp()Superop.random_constrained_unitary()Superop.random_decoherent()Superop.random_stochastic()Superop.random_unitary()Superop.zero()Superop.from_chi()Superop.chiSuperop.plot_chi()Superop.from_kraus()Superop.krausSuperop.plot_kraus()Superop.from_unitary()Superop.from_function()Superop.from_qobj()Superop.qobjSuperop.from_ptm()Superop.ptmSuperop.plot_ptm()Superop.from_herm_ptm()Superop.herm_ptmSuperop.plot_herm_ptm()Superop.from_choi()Superop.choiSuperop.plot_choi()Superop.from_rowstack()Superop.rowstackSuperop.plot_rowstack()Superop.from_rowstack_subsys()Superop.rowstack_subsysSuperop.plot_rowstack_subsys()Superop.from_colstack()Superop.colstackSuperop.plot_colstack()Superop.lkpdSuperop.plot_lkpd()Superop.apply()
- Tensors
TensorTensor.dtypeTensor.labelsTensor.n_sysTensor.shapeTensor.total_dimTensor.spawnTensor.conj()Tensor.adj()Tensor.transpose()Tensor.value()Tensor.mat()Tensor.add_labels()Tensor.merge()Tensor.upgrade()Tensor.marginalize()Tensor.update()Tensor.apply_matrix()Tensor.apply_to_all()Tensor.apply_ufunc()Tensor.dot()Tensor.sample()Tensor.to_results()
StateTensorOperatorTensorto_rowstack_super()
- Weyl Operators
- Operations
- Operation
- Gate
GateGate.ALIASESGate.QUDIT_DIM2_ALIASESGate.QUDIT_DIM3_ALIASESGate.QUDIT_DIM5_ALIASESGate.QUDIT_DIM7_ALIASESGate.from_generators()Gate.get_alias()Gate.is_cliffordGate.is_unitaryGate.is_identityGate.matGate.widthGate.expansionGate.from_alias()Gate.generatorsGate.adjGate.sqrtGate.controlled()Gate.to_clifford()Gate.cw()Gate.embed()Gate.random()Gate.plot()Gate.rp()Gate.rw()Gate.rx()Gate.ry()Gate.rz()Gate.fourier()Gate.w()
- Measurement
- Native Gate
- Preparation
- Protocols
- Results
ResultsResults.get()Results.reset()Results.last_modifiedResults.dimResults.vecResults.n_measurementsResults.n_shotsResults.normalized()Results.sort()Results.marginal()Results.from_vec()Results.subsample()Results.tvd()Results.decompiled_results()Results.to_dict()Results.from_dict()Results.plot()
- Sequencer
- Settings
- Simulation
- Simulator
SimulatorSimulator.backendSimulator.get_dim()Simulator.noise_sourcesSimulator.append_noise_source()Simulator.process()Simulator.operator()Simulator.run()Simulator.sample()Simulator.state()Simulator.add_cycle_noise()Simulator.add_depolarizing()Simulator.add_gate_replace()Simulator.add_knr_noise()Simulator.add_kraus()Simulator.add_overrotation()Simulator.add_prep()Simulator.add_rcal_noise()Simulator.add_readout_error()Simulator.add_relaxation()Simulator.add_stochastic_pauli()Simulator.add_stochastic_weyl()Simulator.add_superop()Simulator.dressed_noise()Simulator.predict_cb()Simulator.predict_irb()Simulator.predict_knr()Simulator.predict_srb()
- Simulation Backends
SimulationBackendSimulationBackend.new_runner()SimulationBackend.RunnerSimulationBackend.Runner.dimSimulationBackend.Runner.meas_policySimulationBackend.Runner.n_shotsSimulationBackend.Runner.prep_policySimulationBackend.Runner.divide()SimulationBackend.Runner.process_confusion()SimulationBackend.Runner.process_gate()SimulationBackend.Runner.process_meas()SimulationBackend.Runner.process_mixed_prep()SimulationBackend.Runner.process_prep()SimulationBackend.Runner.process_povm()SimulationBackend.Runner.process_pure_prep()SimulationBackend.Runner.process_superop()SimulationBackend.Runner.value
MeasPolicyPrepPolicyPropagationBackendPropagationBackend.RunnerPropagationBackend.Runner.meas_labelsPropagationBackend.Runner.process_gate()PropagationBackend.Runner.process_meas()PropagationBackend.Runner.process_povm()PropagationBackend.Runner.process_confusion()PropagationBackend.Runner.process_prep()PropagationBackend.Runner.process_pure_prep()PropagationBackend.Runner.process_mixed_prep()PropagationBackend.Runner.dimPropagationBackend.Runner.divide()PropagationBackend.Runner.meas_policyPropagationBackend.Runner.n_shotsPropagationBackend.Runner.prep_policyPropagationBackend.Runner.process_superop()PropagationBackend.Runner.value
PropagationBackend.new_runner()
- Match
- NoiseSource
- Cycle Matches
- CycleWrapper
- OpWrapper
- Simulator
- Subsystems
- Twirl
- Utilities
dict_to_words()docs()get_schema()get_schema_validator()use_schema_options()allclose()add_deprecation()deprecated()deprecated_class()deprecated_class_property()filter_warnings()rename_deprecation()min_max()shelve_cache()delayed_importoptional_import()flatten()to_tuple_int()dicts_close()temp_folder()save()load()labels_contain_cycle()parallel_map()repr_builder()riffle_chain()get_template()BadModuleItemSetDisplayWrappercached_propertyTrueQUnpicklerUpgradePath
- Visualization
- Graph
GraphGraph.NODE_COLORGraph.NODE_SIZEGraph.ACTIVE_NODE_COLORGraph.LABELED_NODE_DIAMETERGraph.EDGE_COLORGraph.EDGE_WIDTHGraph.ACTIVE_EDGE_COLORGraph.ACTIVE_EDGE_FRACGraph.LABEL_OFFSETGraph.LABEL_REPRGraph.LABEL_STYLEGraph.edgesGraph.labelsGraph.aspen_11()Graph.aspen_m_1()Graph.rigetti_octagon()Graph.ibmq_grid()Graph.ibmq_7()Graph.ibmq_15()Graph.ibmq_20a()Graph.ibmq_20b()Graph.ibmq_27()Graph.ibmq_28()Graph.ibmq_53()Graph.ibmq_65()Graph.ibmq_butterfly()Graph.ibmq_T()Graph.linear()Graph.grid()Graph.sycamore()Graph.to_label()Graph.from_label()Graph.add_graph()Graph.plot()
- Multipy Lightness
- Plot Mat
- Plot Results
- Compare
- Compare Pauli Infidelities
- Compare RB
- Compare Twirl
- IRB Summary
- NOX
- KNR Heatmap
- Raw
- PlottingSuite
- Plotter
- Timestamps
- Graph