Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.09 KB

README.rst

File metadata and controls

62 lines (45 loc) · 2.09 KB
Raw

Welcome to QInfer

image

image

image

Code Climate

QInfer is a library using Bayesian sequential Monte Carlo for quantum parameter estimation. Works with Python 2.7, 3.3, 3.4 and 3.5.

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 git@github.com:QInfer/python-qinfer.git
$ cd python-qinfer
$ pip install -r requirements.txt
$ python setup.py install

More Information

Full documentation for QInfer is available on ReadTheDocs, or may be built locally by running the documentation build script in doc/:

$ cd /path/to/qinfer/doc/
$ make html

On Windows:

C:\> cd C:\path\to\qinfer\
C:\path\to\qinfer\> make.bat html

The generated documentation can be viewed by opening doc/_build/html/index.html.