Introduction

QInfer is a library for working with sequential Monte Carlo methods for parameter estimation in quantum information. QInfer will use your custom experimental models to estimate properties of those models based on experimental data.

Additionally, QInfer is designed for use with cutting-edge tools, such as Python and IPython, making it easier to integrate with the rich community of Python-based scientific software libraries.

Installing QInfer

We recommend using QInfer with the Anaconda distribution. Download and install Anaconda for your platform, either Python 2.7 or 3.5. We suggest using Python 3.5, but QInfer works with either. Next, ensure that you have Git installed. On Windows, we suggest the official Git downloads. Once Anaconda and Git are installed, simply run pip to install QInfer:

$ pip install git+https://github.com/QInfer/python-qinfer.git

Alternatively, QInfer can be installed manually by downloading from GitHub, then running the provided installer:

$ git clone [email protected]:QInfer/python-qinfer.git
$ cd python-qinfer
$ pip install -r requirements.txt
$ python setup.py install

Citing QInfer

If you use QInfer in your publication or presentation, we would appreciate it if you cited our work. We recommend citing QInfer by using the BibTeX entry:

@Misc{,
  author = {Christopher Granade and Christopher Ferrie and others},
  title =  {{QInfer}: Library for Statistical Inference in Quantum Information},
  year =   {2012--},
  url =    "https://github.com/QInfer/python-qinfer"
}

To indicate which version of QInfer you used in your work, it may be helpful to cite a given SHA hash as listed on GitHub (the hashes of each commit are listed on the right hand side of the page). A recommended BibTeX entry for citing a particular version is:

@Misc{,
  author = {Christopher Granade and Christopher Ferrie and others},
  title =  {{QInfer}: Library for Statistical Inference in Quantum Information},
  year =   {2012},
  month =  {2},
  day =    {18},
  url =    "https://github.com/QInfer/python-qinfer/commit/d04bc1d53933f13065917c15ccb0e2f127de3b8a",
  note =   {Version \texttt{d04bc1d53933f13065917c15ccb0e2f127de3b8a}.}
}

In this example, d04bc1d53933f13065917c15ccb0e2f127de3b8a should be replaced by the particular version being cited.

Getting Started

To get started using QInfer, it may be helpful to give a look through the User’s Guide. Alternatively, you may want to dive right into looking at the examples using IPython Notebook. To do so, from your system command line, navigate to where you downloaded QInfer, then run:

cd python-qinfer/examples
ipython notebook

Alternatively, IPython provides an online viewer for reading notebook files:

More details can be found in the Examples section.