54 lines (42 loc) · 2.17 KB

📖 Documentation

Important

QuEST's v4 documentation is still under construction.

QuEST has been overhauled! See

🎉 v4.md for the exciting new features.

To get started with QuEST, check out

🔧 compilers.md for a list of compatible compilers.
🔗 qtechtheory.org for some help downloading compilers.
🛠️ compile.md for instructions on compiling.
⚙️ cmake.md for a list of compiler variables.
🚀 launch.md to learn how to run QuEST on laptops to supercomputers.
🎓 tutorial.md for an introductory tutorial.
📋 API for the documentation of each function.

Interested in contributing? Then check out:

❤️ contributing.md to learn how to make a pull request.
🏗️ architecture.md to understand the code structure.
🎨 styleguide.md for some tips on writing neat code.

Want to learn how what's under the hood? Read the

🏆 whitepaper which featured in Scientific Report's Top 100 in Physics
📝 preprint which derives v4's optimised algorithms.
🧪 tests which compare QuEST's outputs to non-optimised calculations.
📰 news which summarises QuEST's history and accolades.
📈 benchmarks which are coming soon!

If QuEST is useful to you, feel free to cite

@article{jones2019quest,
  title={QuEST and high performance simulation of quantum computers},
  author={Jones, Tyson and Brown, Anna and Bush, Ian and Benjamin, Simon C},
  journal={Scientific reports},
  volume={9},
  number={1},
  pages={10736},
  year={2019},
  publisher={Nature Publishing Group UK London}
}