Skip to content
Travis Scholten edited this page Jul 22, 2014 · 6 revisions

Welcome to the qcircuit wiki main page! Hopefully this wiki provides useful help, documentation, and other information for the use of qcircuit.

About

This project was originally started by Bryan Eastin and Steve Flammia while working at the University of New Mexico, New Mexico, USA. Their contributions have helped scientists within the quantum information community typeset quantum circuits in a rapid and effective manner. The entire community is indebted to them for their work.

Recently, students affiliated with the Center for Quantum Information and Control had the idea to "reboot" the project. With the advent of more effective means of collaboration for coding such as GitHub, as well as new graphics packages for Latex/Tex such as Tikz, we feel the time is right to begin updating qcircuit.

Getting Help/Submitting Ideas

The first place to go to get help on using qcircuit is to download and compile the Qtutorial.tex file. We also have a FAQ page with a few questions and answers.

Should you discover a bug, or have an idea for a new feature, please submit an Issue.

If you need to contact a human, please visit the user page for Travis-S.

Future Work

Where We Are

Currently, our work involves simply taking the files already generated by Steve and Bryan and putting them into this repository. We have introduced some minor updates to make qcircuit feel more like a package. We are in the process of submitting a package to CTAN.

As far as the software goes, this .sty file must be manually inserted by the user into their local TeX tree. This is undesirable in several aspects, the first of which is that any updates to qcircuit are not automatically propagated to the user. Furthermore, a lack of standardized download and install can hinder the use and adoption of qcircuit -- software should "just work".

Where Are Going

One obvious direction we are pursuing is to propagate qcircuit to the wider TeX community. In particular, putting qcircuit on CTAN would enable easier access by users, as well as provide a more convenient mechanism for software updates.

Another, perhaps very ambitious, direction, is to update qcircuit to be compatible with current LaTeX drawing packages. In particular, the TikZ package has emerged as a helpful way to do drawing; making qcircuit compatible with that would enable further development down the line.

Workflow Management

This repository has three main branches: master, dev, and pack. The master branch is, as the name suggests, the most stable branch. The dev branch serves as a stop before the master branch. Changes should be committed to the dev branch first, and then, upon verifying few things break (can never get rid of all of them!), the dev branch can be merged into master. Currently, I am using the pack branch for the purposes of addressing the suggestion above of making qcircuit into a full-fledged LaTeX package.

Clone this wiki locally