Python Jaqal Programming Package (JaqalPaq)¶
API Reference¶
JaqalPaq currently consists of the
jaqalpaq
Python package, and its subpackages.
The
jaqalpaq.core
package implements an object representation of scheduled quantum circuits. It supports programmatically constructing and manipulating circuits.The
jaqalpaq.parser
package parses Jaqal source files intojaqalpaq.core.Circuit
objects.The
jaqalpaq.generator
package generates Jaqal code that implements the quantum circuit described by ajaqalpaq.core.Circuit
object.The
jaqalpaq.emulator
package 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.scheduler
package 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.tket
packages allow conversion betweenjaqalpaq.core
objects 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.JaqalError
class and a collection of RESERVED_WORDS
.