Skip to content

QuEST-Kit/QuEST

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

The QuEST logo

GitHub release Doc unit tests MIT license

The Quantum Exact Simulation Toolkit is a high performance simulator of quantum circuits, state-vectors and density matrices. QuEST uses multithreading, GPU acceleration and distribution to run lightning first on laptops, desktops and networked supercomputers. QuEST just works; it is stand-alone, requires no installation, and trivial to compile and getting running.

Languages Languages OS OS OS Platforms Platforms Platforms

QuEST is developed by the QTechTheory group at the University of Oxford, and these authors. To learn more:

DOI Email


🎉  Introduction

QuEST has a simple interface, which is agnostic to its runtime environment, between CPUs, GPUs and over networks.

hadamard(qubits, 0);

controlledRotateX(qubits, 0, 1, angle);

double prob = calcProbOfOutcome(qubits, 0, outcome);

Yet, it is flexible

Vector v;
v.x = 1; v.y = .5; v.z = 0;
rotateAroundAxis(qubits, 0, angle, v);

ComplexMatrix2 u = {
    .real = {{.5, .5}, { .5,.5}},
    .imag = {{.5,-.5}, {-.5,.5}}};
unitary(qubits, 0, u);

mixDepolarising(qubits, 0, prob);

and extremely powerful

ComplexMatrixN u = createComplexMatrixN(5);
int ctrls[] = {0, 1, 2};
int targs[] = {5, 20, 15, 10, 25};
multiControlledMultiQubitUnitary(qubits, ctrls, 3, targs, 5, u);

ComplexMatrixN k1, k2, k3 = ...
mixMultiQubitKrausMap(qubits, targs, 5, {k1, k2, k3}, 3);

double val = calcExpecPauliHamil(qubits, hamiltonian, workspace);

applyTrotterCircuit(qubits, hamiltonian, time, order, repetitions);

  Features

QuEST supports:

  • ☑️   density matrices for precise simulation of noisy quantum computers
  • ☑️   general unitaries with any number of control and target qubits
  • ☑️   general decoherence channels of any dimension
  • ☑️   general Hermitian operators in the Pauli basis
  • ☑️   many many operators, including even Pauli gadgets, analytic phase functions and Trotter circuits
  • ☑️   many tools to analyse quantum states, such as calculations of probability, fidelity, and expected value
  • ☑️   variable precision through a qreal numerical type which can use single, double or quad precision
  • ☑️   QASM output to verify simulated circuits
  • ☑️   direct access to amplitudes for rapid custom modification of the quantum state
  • ☑️   native compilation on MacOS, Linux and Windows, through Clang, GNU, Intel, and MSVC compilers

📖  Documentation

For developers: To regenerate the doc after making changes to the code, run doxygen doxyconfig/config in the root directory. This will generate documentation in Doxygen_doc/html, the contents of which should be copied into docs/


🚀  Getting started

To rocket right in, download QuEST with git at the terminal

git clone https://github.com/quest-kit/QuEST.git
cd QuEST

Compile the tutorial example (source) using cmake and make

mkdir build
cd build
cmake ..
make

then run it with

./demo

Windows users should install Build Tools for Visual Studio, and CMake, and run the above commmands in the Developer Command Prompt for VS, though using build commands

cmake .. -G "NMake Makefiles"
nmake

If using MSVC and NMake in this way fails, users can forego GPU acceleration, download MinGW-w64, and compile via

cmake .. -G "MinGW Makefiles"
make

❤️  Acknowledgements

We sincerely thank the following external contributors to QuEST.

QuEST uses the mt19937ar Mersenne Twister algorithm for random number generation, under the BSD licence. QuEST optionally (by additionally importing QuEST_complex.h) integrates the language agnostic complex type by Randy Meyers and Dr. Thomas Plum


📰  Related projects

  • QuESTlink
    a Mathematica package enabling symbolic circuit manipulation, analytic simulation, visualisation and high performance simulation with remote accelerated hardware.

  • pyQuEST
    a python interface to QuEST, based on Cython, developed within the QTechTheory group. Please note, pyQuEST is currently in the alpha stage.

  • PyQuEST-cffi
    a python interface to QuEST based on cffi developed by HQS Quantum Simulations. Please note, PyQuEST-cffi is currently in the alpha stage and not an official QuEST project.