README.md

This is a prototype simulator and compiler for the Qunity quantum programming language, based on the paper by Voichick et al. (https://arxiv.org/abs/2204.12384), and the typechecker implementation in Coq (https://gitlab.umiacs.umd.edu/finn/qunity). This project is done as part of Caltech's SURF program, supervised by Robert Rand at UChicago. It is supported by the Samuel P. and Frances Krown SURF Fellowship.

To run the tests:

./run-tests

To run a single program using the simulator:

./qunity-run <filename>

To run all the example Qunity programs located in the examples folder:

./run-all-examples

To start an interactive Qunity REPL¹:

./qunity-interact

To compile a single Qunity file into OpenQASM 3:

./qunity-compile <in_filename> [-o <out_filename>] [--nobuild] [--annotate] [--analyze]

If no output filename is specified, by default it goes in the qasm_out directory. If --nobuild is used, dune build is not run before compiling. If --annotate is used, the output file will have comments that indicate the roles of the qubits in each of the gates in the low-level circuit. If --analyze is used, a circuit diagram will be generated, and the circuit will be simulated using Qiskit.

To compile all the example Qunity programs:

./compile-all-examples [--annotate] [--analyze]

Footnotes

1. To avoid some input/prompt issues, it is recommended to add the following to your ~/.inputrc:

   $include /etc/inputrc
   # To prevent prompt from disappearing:
   set enable-bracketed-paste off
   # Optional - to prevent parentheses blinking:
   set blink-matching-paren off
   

   ↩