README.md

The scripts in this repository are used to collect data for two benchmarks and plot the results.

First, circuit construction performance with OpenQudit is measured agaisnt Tket and Qiskit. To collect and plot the data:

1. Collect data for Tket and Qiskit by running benchpress.
2. Collect data for OpenQudit by compiling and running the included run-benchpress-construct crate.
3. Input the data into the draw_graph.py script, and run it.

Second, BQSKit's best general-purpose compilation is measured agaisnt Tket and Qiskit compilation. To collect and plot the data:

1. To generate the Benchpress circuits, run partition_feynman, partition_hamiltonians, and partition_qasm_bench to generate the corresponding benchpress BQSKit circuits and store them in the a partitioned_circuits directory.
2. Then, you can launch the BQSKit compiler by running run_circ with the corresponding benchmark name.
3. This will output the circuit data into a pickle file. To gather all the data, then run the gather_counts.py.
4. Finally, input the gathered data to draw_graph.py and run. X. The generated pickle file will be auto-detected by the draw_graph.py script, which can be used to plot the results.