z ivJ4SrSSKJr SSKrSSKrSSKrSSKJr SSK J r SSK J r SSK Jr SSK Jr S S KJr S S KJrJrJr S S KJr S SKJrJr \R8(aSSK JrJr /\"\ R>SS S 5P\"\ R@SSS 5P\"\ RBSSS 5P\"\ RDSSS 5P\"\ RFSSS 5P\"\ RHSSS 5P\"\ RJSSS 5P\"\ RLSSS 5P\"\ RNSSS 5P\"\ RPSSS 5P\"\ RRSS S 5P\"\ RTSS S 5P\"\ RVSS S 5P\"\ RXSSS 5P\"\ RZSSS 5P\"\ R\SSS 5P\"\ R^S S S 5P\"\ R`S!S S 5P\"\ RbS"S S 5P\"\ RdS#S S 5P\"\ RfS$SS 5P\"\ RhS%SS 5P\"\ RjS&SS'5P\"\ RlS(SS'5P\"\ RnS)S*S 5P\"\ RXS+SS 5P\"\ R>S,S S 5P\"\ R^S-S S 5P\"\ RpS.SS 5P\"\ RrS/S S 5P\"\ RtS0S S 5P\"\ RvS1S'S 5P7r\R~RS45SSS5.SCS6jj5rA\R~RS45SSS5.SDS7jj5rB\R"\R5SSS8.S9j5rD\R"\R5SSS8.S:j5rE\R"\Rz5SSS;S.S?j5rF\R"\R|5SSS;S.S@j5rGg)Ea ================================ OpenQASM 3 (:mod:`qiskit.qasm3`) ================================ .. currentmodule:: qiskit.qasm3 Qiskit provides some tools for converting between `OpenQASM 3 `__ representations of quantum programs, and the :class:`.QuantumCircuit` class. These will continue to evolve as Qiskit's support for the dynamic-circuit capabilities expressed by OpenQASM 3 increases. Exporting to OpenQASM 3 ======================= The high-level functions are simply :func:`dump` and :func:`dumps`, which respectively export to a file (given as a filename) and to a Python string. .. autofunction:: dump .. autofunction:: dumps Both of these exporter functions are single-use wrappers around the main :class:`Exporter` class. For more complex exporting needs, including dumping multiple circuits in a single session, it may be more convenient or faster to use the complete interface. .. autoclass:: Exporter :members: All of these interfaces will raise :exc:`QASM3ExporterError` on failure. .. autoexception:: QASM3ExporterError Experimental features --------------------- The OpenQASM 3 language is still evolving as hardware capabilities improve, so there is no final syntax that Qiskit can reliably target. In order to represent the evolving language, we will sometimes release features before formal standardization, which may need to change as the review process in the OpenQASM 3 design committees progresses. By default, the exporters will only support standardised features of the language. To enable these early-release features, use the ``experimental`` keyword argument of :func:`dump` and :func:`dumps`. The available feature flags are: .. autoclass:: ExperimentalFeatures :members: If you want to enable multiple experimental features, you should combine the flags using the ``|`` operator, such as ``flag1 | flag2``. For example, to perform an export using the early semantics of ``switch`` support: .. plot:: :include-source: :nofigs: from qiskit import qasm3, QuantumCircuit, QuantumRegister, ClassicalRegister # Build the circuit qreg = QuantumRegister(3) creg = ClassicalRegister(3) qc = QuantumCircuit(qreg, creg) with qc.switch(creg) as case: with case(0): qc.x(0) with case(1, 2): qc.x(1) with case(case.DEFAULT): qc.x(2) # Export to an OpenQASM 3 string. qasm_string = qasm3.dumps(qc, experimental=qasm3.ExperimentalFeatures.SWITCH_CASE_V1) .. note:: All features enabled by the experimental flags are naturally transient. If it becomes necessary to remove flags, they will be subject to `the standard Qiskit deprecation policy `__. We will leave these experimental flags in place for as long as is reasonable. However, we cannot guarantee any support windows for *consumers* of OpenQASM 3 code generated using these experimental flags, if the OpenQASM 3 language specification changes the proposal that the flag is based on. It is possible that any tool you are using to consume OpenQASM 3 code created using these flags may update or remove their support while Qiskit continues to offer the flag. You should not rely on the resultant experimental OpenQASM 3 code for long-term storage of programs. Importing from OpenQASM 3 ========================= Currently only two high-level functions are offered, as Qiskit support for importing from OpenQASM 3 is in its infancy, and the implementation is expected to change significantly. The two functions are :func:`load` and :func:`loads`, which are direct counterparts of :func:`dump` and :func:`dumps`, respectively loading a program indirectly from a named file and directly from a given string. .. note:: While we are still in the exploratory release period, to use either function, the package ``qiskit_qasm3_import`` must be installed. This can be done by installing Qiskit with the ``qasm3-import`` extra, such as by: .. code-block:: text pip install qiskit[qasm3-import] We expect that this functionality will eventually be merged into Qiskit, and no longer require an optional import, but we do not yet have a timeline for this. .. autofunction:: load .. autofunction:: loads Both of these two functions raise :exc:`QASM3ImporterError` on failure. .. autoexception:: QASM3ImporterError For example, we can define a quantum program using OpenQASM 3, and use :func:`loads` to directly convert it into a :class:`.QuantumCircuit`: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: import qiskit.qasm3 program = """ OPENQASM 3.0; include "stdgates.inc"; input float[64] a; qubit[3] q; bit[2] mid; bit[3] out; let aliased = q[0:1]; gate my_gate(a) c, t { gphase(a / 2); ry(a) c; cx c, t; } gate my_phase(a) c { ctrl @ inv @ gphase(a) c; } my_gate(a * 2) aliased[0], q[{1, 2}][0]; measure q[0] -> mid[0]; measure q[1] -> mid[1]; while (mid == "00") { reset q[0]; reset q[1]; my_gate(a) q[0], q[1]; my_phase(a - pi/2) q[1]; mid[0] = measure q[0]; mid[1] = measure q[1]; } if (mid[0]) { let inner_alias = q[{0, 1}]; reset inner_alias; } out = measure q; """ circuit = qiskit.qasm3.loads(program) circuit.draw("mpl") Experimental import interface ----------------------------- The import functions given above rely on the ANTLR-based reference parser from the OpenQASM project itself, which is more intended as a language reference than a performant parser. You need to have the extension ``qiskit-qasm3-import`` installed to use it. Qiskit is developing a native parser, written in Rust, which is available as part of the core Qiskit package. This parser is still in its early experimental stages, so is missing features and its interface is changing and expanding, but it is typically orders of magnitude more performant for the subset of OpenQASM 3 it currently supports, and its internals produce better error diagnostics on parsing failures. You can use the experimental interface immediately, with similar functions to the main interface above: .. autofunction:: load_experimental .. autofunction:: loads_experimental These two functions are both experimental, meaning they issue an :exc:`.ExperimentalWarning` on usage, and their interfaces may be subject to change within the Qiskit 1.x release series. In particular, the native parser may be promoted to be the default version of :func:`load` and :func:`loads`. If you are happy to accept the risk of using the experimental interface, you can disable the warning by doing:: import warnings from qiskit.exceptions import ExperimentalWarning warnings.filterwarnings("ignore", category=ExperimentalWarning, module="qiskit.qasm3") These two functions allow for specifying include paths as an iterable of paths, and for specifying custom Python constructors to use for particular gates. These custom constructors are specified by using the :class:`CustomGate` object: .. autoclass:: CustomGate :members: In ``custom_gates`` is not given, Qiskit will attempt to use its standard-library gate objects for the gates defined in OpenQASM 3 standard library file ``stdgates.inc``. This sequence of gates is available on this module, if you wish to build on top of it: .. py:data:: STDGATES_INC_GATES A tuple of :class:`CustomGate` objects specifying the Qiskit constructors to use for the ``stdgates.inc`` include file. ) annotationsN)qasm3)library)ExperimentalWarning) optionals)Qubit) CustomGate) QASM3ErrorQASM3ExporterErrorQASM3ImporterError)ExperimentalFeatures)ExporterDefcalInstruction) annotationQuantumCircuitpxyzhssdgttdgsxrxryrzcxcyczcpcrxcrycrzchswapccxcswapcuCXphasecphaseidu1u2u3c 6[S0UD6RU5$)zSerialize a :class:`~qiskit.circuit.QuantumCircuit` object in an OpenQASM 3 string. Args: circuit (QuantumCircuit): Circuit to serialize. **kwargs: Arguments for the :obj:`.Exporter` constructor. Returns: str: The OpenQASM 3 serialization )rdumps)circuitkwargss O/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/qasm3/__init__.pyr8r8s  f  # #G ,,c 8[S0UD6RX5 g)a3Serialize a :class:`~qiskit.circuit.QuantumCircuit` object as an OpenQASM 3 stream to file-like object. Args: circuit (QuantumCircuit): Circuit to serialize. stream (TextIOBase): stream-like object to dump the OpenQASM 3 serialization **kwargs: Arguments for the :obj:`.Exporter` constructor. Nr7)rdump)r9streamr:s r;r>r>*s vG,r<zloading from OpenQASM 3 num_qubitsannotation_handlersc[US5nUR5nSSS5 [WXS9$!,(df  N=f)aLoad an OpenQASM 3 program from the file ``filename``. Args: filename: the filename to load the program from. num_qubits: keyword argument which provides number of physical/virtual qubits. annotation_handlers: a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires ``qiskit_qasm3_import>=0.6.0``. Returns: QuantumCircuit: a circuit representation of the OpenQASM 3 program. Raises: QASM3ImporterError: if the OpenQASM 3 file is invalid, or cannot be represented by a :class:`.QuantumCircuit`. .. versionadded:: 2.1 The ``annotation_handlers`` argument. This requires ``qiskit_qasm3_import>=0.6.0``. rNr@)openreadloads)filenamerArBfptrprograms r;loadrK7s62 h ))+  Z YY  s0 >cSSKn0nUb-[USS5S:a[SUR-5eX$S'UR"U40UD6nUGblURU:a [S5eXR- =nS:Ga<URbURSsol [URR5R5S S 9n [U S -U5H'n URR![#5U 5 M) 0n [U S -U5Hn XURU 'M UR$R'U 5 UR)[U5V s/sH n [#5PM sn 5 Xl U$UR)[U5V s/sH n [#5PM sn 5 U$!UR an[[ U55UeSnAff=fs sn fs sn f) a[Load an OpenQASM 3 program from the given string. Examples: Load a OpenQASM3 string into a quantum circuit with/without `num_qubits` argument. .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit import qasm3 # An OpenQASM 3 program that only uses 2 physical qubits. prog = ''' OPENQASM 3.0; include "stdgates.inc"; h $0; cx $0, $1; ''' # The importer can be supplied with the number of qubits in the target backend. # so the result is full width. qc = qasm3.loads(prog, num_qubits=5) assert qc.num_qubits == 5 Args: program: the OpenQASM 3 program. num_qubits: provides number of physical/virtual qubits. annotation_handlers: a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires ``qiskit_qasm3_import>=0.6.0``. Returns: QuantumCircuit: a circuit representation of the OpenQASM 3 program. Raises: QASM3ImporterError: if the OpenQASM 3 file is invalid, or cannot be represented by a :class:`.QuantumCircuit`. ValueError: if number of qubits in qasm3_ckt is more than num_qubits. .. versionadded:: 2.1 The ``annotation_handlers`` argument. This requires ``qiskit_qasm3_import>=0.6.0``. rN VERSION_PARTS)rr)rzFneed 'qiskit_qasm3_import>=0.6.0' to handle annotations, but you have rBzTNumber of qubits cannot be more than the provided number of physical/virtual qubits.)defaultr )qiskit_qasm3_importgetattrr __version__parseConversionErrorstrrA ValueErrorlayout_layoutmaxinitial_layoutget_physical_bitskeysrangeaddrinput_qubit_mappingupdateadd_bits)rJrArBrQr: qasm3_cktexc differencerXlastk mapping_dictii_s r;rGrGUs` F& & @6 I$X%112 )<$%4'--g@@    * ,f %';';; ;Jq @+,5,=,=t))600BBDIIKUWXtax4A))--egq95 " q*5B>@!6!6r!:;6**11,?""U:5F#G5FEG5F#GH%+! ""U:5F#G5FEG5F#GH E  . .4 S*342$H$Hs#F=%G* G/=G' G""G' custom_gates include_pathc^[R"S[S9 [R"XUS9$zThis is an experimental native version of the OpenQASM 3 importer. Beware that its interface might change, and it might be missing features.categoryrk)warningswarnr_qasm3rG)sourcerlrms r;loads_experimentalrws, MM U$ << UUr<c^[R"S[S9 [R"XUS9$ro)rsrtrrurK)pathlike_or_filelikerlrms r;load_experimentalrzs. MM U$ ;;+Ua bbr<TFz includes basis_gatesdisable_constantsalias_classical_registersallow_aliasingindentc [R"S[S9 UcS/nUcS/n[R"UUUUUUUS.5$rpzThis is an experimental version of serialization of a :class:`~qiskit.circuit.QuantumCircuit` object in an OpenQASM 3 string. Beware that its interface might change, and it might be missing features.rqz stdgates.incUr{)rsrtrrur8)r9r|r}r~rrrs r;dumps_experimentalrsc MM U%  "#e << &!2)B,    r<c [R"S[S9 UcS/nUcS/n[R"UUUUUUUUS.5$r)rsrtrrur>)r9r?r|r}r~rrrs r;dump_experimentalrsf MM U%  "#e ;; &!2)B,    r<)returnrV)rNone)rHrVrA int | NonerB0dict[str, annotation.OpenQASM3Serializer] | Nonerr)rJrVrArrBrrr)H__doc__ __future__r functoolstypingrsqiskit._acceleraterruqiskit.circuitrqiskit.exceptionsr qiskit.utilsr _optionalsr_accelerate.qasm3r exceptionsr r r experimentalrexporterrr TYPE_CHECKINGrr PhaseGateXGateYGateZGateHGateSGateSdgGateTGateTdgGateSXGateRXGateRYGateRZGateCXGateCYGateCZGate CPhaseGateCRXGateCRYGateCRZGateCHGateSwapGateCCXGate CSwapGateCUGateIGateU1GateU2GateU3GateSTDGATES_INC_GATESr8r>HAS_QASM3_IMPORTrequire_in_callrKrGwrapsrwrzrrr7r<r;rsVp# ."10 *JJ.1 9!w  #q!,!w}}c1a(!w}}c1a(!w}}c1a( ! w}}c1a( ! w}}c1a( !wq!,!w}}c1a(!wq!,!w~~tQ*!w~~tQ*!w~~tQ*!w~~tQ*!w~~tQ*!w~~tQ*! w~~tQ*!!"w!!4A.#!$wq!,%!&wq!,'!(wq!,)!*w~~tQ*+!,wA.-!.wq!,/!0w  '1a01!2w~~tQ*3!4w~~tQ*5!6w  '1a07!8w!!8Q29!:w}}dAq);!<w~~tQ*=!>w~~tQ*?!@w~~tQ*A!H - - ,,-FG"LP ZZZJ Z  ZHZ: ,,-FG"LP ^ ^^J ^  ^H^B 26TVV ?CRVcc # D  # ""r<