Introduction

MIMIQ Circuits is a quantum computing framework and high performance simulator developed by QPerfect. It allows you to develop and run your quantum algorithms beyond the limits of today’s noisy intermediate scale quantum (NISQ) computers.

Quick Start

mimiqcircuits.py is a Python Language package containing all the utilities and programming interfaces (APIs)

to build quantum systems, connect, and execute simulations on QPerfect’s MIMIQ-CIRC large-scale quantum circuit simulator.

To install mimiqcircuits.py you can use the following command:

pip install "mimiqcircuits @ git+https://github.com/qperfect-io/mimiqcircuits-python.git"

For more details on installation, please refer to the Installation page.

Indices and tables

• Index

• Module Index

• Search Page

Contents

• Installation
  • Installation
• Tutorial
  • Building a Quantum circuit
  • Remote execution on MIMIQ-CIRC
  • Connecting to MIMIQ
  • executing a Circuit on MIMIQ
  • Retrieving execution results
  • Retrieving execsubmitted remote jobs
• Manual
  • Circuit Execution on MIMIQ
    • Understanding sampling and executions
      • No non-unitary operations
      • No mid-circuit measurements and no non-unitary operations
      • Mid-circuit measurements or non-unitary operations
    • Fidelity and Error estimates
    • Timings
  • OpenQASM in MIMIQ-CIRC
    • Behaviour of include files
    • Relations between OpenQASM registers and MIMIQ indices
• API References
  • AsciiCanvas
    • AsciiCanvas.draw_box()
    • AsciiCanvas.draw_double_hline()
    • AsciiCanvas.draw_double_vline()
    • AsciiCanvas.draw_empty()
    • AsciiCanvas.draw_fill()
    • AsciiCanvas.draw_hline()
    • AsciiCanvas.draw_text()
    • AsciiCanvas.draw_vline()
    • AsciiCanvas.draw_vtext()
    • AsciiCanvas.get_cols()
    • AsciiCanvas.get_rows()
    • AsciiCanvas.push_line()
    • AsciiCanvas.reset()
  • AsciiCircuit
    • AsciiCircuit.draw_barrier()
    • AsciiCircuit.draw_control()
    • AsciiCircuit.draw_ifstatement()
    • AsciiCircuit.draw_instruction()
    • AsciiCircuit.draw_measure()
    • AsciiCircuit.draw_operation()
    • AsciiCircuit.draw_parallel()
    • AsciiCircuit.draw_reset()
    • AsciiCircuit.draw_wires()
    • AsciiCircuit.get_bit_row()
    • AsciiCircuit.get_current_col()
    • AsciiCircuit.get_qubit_row()
    • AsciiCircuit.reset()
    • AsciiCircuit.set_current_col()
  • Barrier
    • Barrier.asciiwidth()
    • Barrier.control()
    • Barrier.inverse()
    • Barrier.iswrapper()
    • Barrier.power()
  • BitString
    • BitString.bits
    • BitString.fromfunction()
    • BitString.fromint()
    • BitString.fromnonzeros()
    • BitString.fromstring()
    • BitString.nonzeros()
    • BitString.num_qubits()
    • BitString.to01()
    • BitString.toindex()
    • BitString.tointeger()
    • BitString.zeros()
  • Circuit
    • Circuit.append()
    • Circuit.copy()
    • Circuit.decompose()
    • Circuit.deepcopy()
    • Circuit.depth()
    • Circuit.draw()
    • Circuit.emplace()
    • Circuit.empty()
    • Circuit.evaluate()
    • Circuit.insert()
    • Circuit.inverse()
    • Circuit.is_symbolic()
    • Circuit.loadproto()
    • Circuit.num_bits()
    • Circuit.num_qubits()
    • Circuit.push()
    • Circuit.remove()
    • Circuit.saveproto()
  • Control
    • Control.control()
    • Control.evaluate()
    • Control.get_operation()
    • Control.getparams()
    • Control.inverse()
    • Control.iswrapper()
    • Control.matrix()
    • Control.num_controls
    • Control.num_targets
    • Control.op
    • Control.parallel()
    • Control.power()
  • Diffusion
    • Diffusion.num_qubits
  • Gate
    • Gate.control()
    • Gate.evaluate()
    • Gate.inverse()
    • Gate.iswrapper()
    • Gate.matrix()
    • Gate.parallel()
    • Gate.power()
  • GateC3X
  • GateCCP
  • GateCCX
  • GateCH
  • GateCP
  • GateCRX
  • GateCRY
  • GateCRZ
  • GateCS
  • GateCSDG
  • GateCSWAP
  • GateCSX
  • GateCSXDG
  • GateCU
  • GateCX
  • GateCY
  • GateCZ
  • GateCall
    • GateCall.evaluate()
  • GateCustom
    • GateCustom.evaluate()
    • GateCustom.inverse()
    • GateCustom.is_unitary()
    • GateCustom.num_qubits
  • GateDCX
  • GateDecl
  • GateECR
    • GateECR.inverse()
  • GateH
    • GateH.inverse()
  • GateID
    • GateID.inverse()
  • GateISWAP
  • GateP
    • GateP.inverse()
  • GateR
    • GateR.inverse()
  • GateRX
    • GateRX.inverse()
  • GateRXX
    • GateRXX.inverse()
  • GateRY
    • GateRY.inverse()
  • GateRYY
    • GateRYY.inverse()
  • GateRZ
    • GateRZ.inverse()
  • GateRZX
    • GateRZX.inverse()
  • GateRZZ
    • GateRZZ.inverse()
  • GateS
    • GateS.inverse()
    • GateS.isopalias()
  • GateSDG
    • GateSDG.inverse()
    • GateSDG.isopalias()
  • GateSWAP
    • GateSWAP.inverse()
  • GateSX
    • GateSX.inverse()
    • GateSX.isopalias()
    • GateSX.name
  • GateSXDG
    • GateSXDG.inverse()
    • GateSXDG.isopalias()
  • GateT
    • GateT.inverse()
    • GateT.isopalias()
  • GateTDG
    • GateTDG.inverse()
    • GateTDG.isopalias()
  • GateU
    • GateU.inverse()
  • GateU1
    • GateU1.inverse()
  • GateU2
    • GateU2.inverse()
  • GateU3
    • GateU3.inverse()
  • GateX
    • GateX.inverse()
  • GateXXminusYY
    • GateXXminusYY.inverse()
  • GateXXplusYY
    • GateXXplusYY.inverse()
  • GateY
    • GateY.inverse()
  • GateZ
    • GateZ.inverse()
  • IfStatement
    • IfStatement.ascii_width()
    • IfStatement.control()
    • IfStatement.evaluate()
    • IfStatement.get_operation()
    • IfStatement.get_unwrapped_value()
    • IfStatement.getparams()
    • IfStatement.inverse()
    • IfStatement.iswrapper()
    • IfStatement.op
    • IfStatement.power()
    • IfStatement.val
  • Instruction
    • Instruction.asciiwidth()
    • Instruction.bits
    • Instruction.copy()
    • Instruction.decompose()
    • Instruction.deepcopy()
    • Instruction.evaluate()
    • Instruction.get_bits()
    • Instruction.get_operation()
    • Instruction.get_qubits()
    • Instruction.inverse()
    • Instruction.operation
    • Instruction.qubits
  • Inverse
    • Inverse.control()
    • Inverse.evaluate()
    • Inverse.getparams()
    • Inverse.inverse()
    • Inverse.iswrapper()
    • Inverse.matrix()
    • Inverse.parallel()
    • Inverse.power()
  • LazyArg
  • LazyExpr
    • LazyExpr.control()
    • LazyExpr.inverse()
    • LazyExpr.parallel()
    • LazyExpr.power()
  • Measure
    • Measure.asciiwidth()
    • Measure.control()
    • Measure.from_json()
    • Measure.get_operation()
    • Measure.inverse()
    • Measure.iswrapper()
    • Measure.power()
  • MimiqConnection
    • MimiqConnection.execute()
    • MimiqConnection.get_inputs()
    • MimiqConnection.get_results()
  • Operation
    • Operation.asciiwidth()
    • Operation.copy()
    • Operation.cregsizes
    • Operation.decompose()
    • Operation.deepcopy()
    • Operation.evaluate()
    • Operation.get_operation()
    • Operation.getparam()
    • Operation.getparams()
    • Operation.is_symbolic()
    • Operation.isopalias()
    • Operation.iswrapper()
    • Operation.name
    • Operation.num_bits
    • Operation.num_cregs
    • Operation.num_qregs
    • Operation.num_qubits
    • Operation.parnames
    • Operation.qregsizes
  • Parallel
    • Parallel.control()
    • Parallel.evaluate()
    • Parallel.get_operation()
    • Parallel.inverse()
    • Parallel.iswrapper()
    • Parallel.matrix()
    • Parallel.num_repeats
    • Parallel.op
    • Parallel.parallel()
    • Parallel.power()
  • PhaseGradient
    • PhaseGradient.name
    • PhaseGradient.num_qubits
    • PhaseGradient.qregsizes
  • PolynomialOracle
    • PolynomialOracle.inverse()
  • Power
    • Power.control()
    • Power.decompose()
    • Power.evaluate()
    • Power.exponent
    • Power.getparams()
    • Power.inverse()
    • Power.iswrapper()
    • Power.matrix()
    • Power.op
    • Power.parallel()
    • Power.power()
  • QCSResults
    • QCSResults.histogram()
    • QCSResults.loadproto()
    • QCSResults.saveproto()
  • QFT
    • QFT.name
    • QFT.num_qubits
    • QFT.qregsizes
  • Reset
    • Reset.asciiwidth()
    • Reset.control()
    • Reset.from_json()
    • Reset.inverse()
    • Reset.iswrapper()
    • Reset.power()
  • control()
  • gatedecl()
  • inverse()
  • load_results()
  • parallel()
  • plothistogram()
  • power()
  • save_results()
• GitHub
• Julia APIs
• QPerfect