Contents:
Python Jaqal Programming Package (JaqalPaq)
API Reference
JaqalPaq currently consists of the
jaqalpaq Python package, and its subpackages.
The
jaqalpaq.corepackage implements an object representation of scheduled quantum circuits. It supports programmatically constructing and manipulating circuits.The
jaqalpaq.parserpackage parses Jaqal source files intojaqalpaq.core.Circuitobjects.The
jaqalpaq.generatorpackage generates Jaqal code that implements the quantum circuit described by ajaqalpaq.core.Circuitobject.The
jaqalpaq.emulatorpackage provides noiseless emulation of Jaqal code.
The following subpackages are not part of the basic language features, and must be installed separately from the JaqalPaq-extras repository.
The
jaqalpaq.schedulerpackage modifies circuits to execute more gates in parallel, without changing the function of the circuit or breaking the restrictions of the QSCOUT hardware.The
jaqalpaq.transpilers.cirq,jaqalpaq.transpilers.projectq,jaqalpaq.transpilers.qiskit,jaqalpaq.transpilers.quil, andjaqalpaq.transpilers.tketpackages allow conversion betweenjaqalpaq.coreobjects and their counterparts in other popular quantum software development frameworks.
Additionally, the top-level jaqalpaq package provides a few useful imports that
don’t fit within the scope of any of the above subpackages: the jaqalpaq.error.JaqalError
class and a collection of RESERVED_WORDS.