API documentation¶

Backends for processing pytket circuits with Quantinuum devices

enum pytket.qir.QIRFormat(value)[source]¶

Return types qir, options are BINARY for a binary output and STRING for a string output

Valid values are as follows:

BINARY = <QIRFormat.BINARY: 0>¶

STRING = <QIRFormat.STRING: 1>¶

pytket.qir.pytket_to_qir(circ, name='Generated from input pytket circuit', qir_format=QIRFormat.BINARY, wfh=None, int_type=64, cut_pytket_register=False, profile=False)[source]¶

converts given pytket circuit to qir

Parameters:

circ (Circuit) – given circuit
name (str) – name for the qir module created
qir_format (QIRFormat) – format of the generated qir, default value is binary
wfh (Optional[WasmFileHandler]) – wasm file handler used when creating the circuit. Only needed when there are wasm calls in the circuit.
int_type (int) – size of each integer, allowed value 32 and 64
cut_pytket_register (bool) – breaks up the internal scratch bit registers into smaller registers, default value false
profile (bool) – generates QIR corresponding to the adaptive profile You can find more details about the adaptive profile under: https://github.com/qir-alliance/qir-spec/pull/35 and soon at: https://github.com/qir-alliance/qir-spec/tree/main/specification/under_development/profiles/Adaptive_Profile.md

Return type:

Union[str, bytes, None]