Awesome

Yao Extensible, Efficient Quantum Algorithm Design for Humans.

Introduction

Yao is an open source framework that aims to empower quantum information research with software tools. It is designed with following in mind:

quantum algorithm design;
quantum software 2.0;
quantum computation education.

We are in an early-release beta. Expect some adventures and rough edges.

Try your first Yao program

A 3 line Quantum Fourier Transformation with Quantum Blocks:

A(i, j) = control(i, j=>shift(2π/(1<<(i-j+1))))
B(n, k) = chain(n, j==k ? put(k=>H) : A(j, k) for j in k:n)
qft(n) = chain(B(n, k) for k in 1:n)

Installation

<p> Yao is a   <a href="https://julialang.org"> <img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em"> Julia Language </a>   package. To install Yao, please <a href="https://docs.julialang.org/en/v1/manual/getting-started/">open Julia's interactive session (known as REPL)</a> and press <kbd>]</kbd> key in the REPL to use the package mode, then type the following command </p>

For stable release

pkg> add Yao

For current master

pkg> add Yao#master

If you have problem to install the package, please file us an issue.

For CUDA support, see CuYao.jl.

For tensor network based simulations, see YaoToEinsum.jl.

Documentation

Tutorial | Learn Quantum Computing with Yao

Algorithm Zoo

Some quantum algorithms are implemented with Yao in QuAlgorithmZoo.

Online Documentation

STABLE — most recently tagged version of the documentation.
LATEST — in-development version of the documentation.

Monthly Community Call

We are running a monthly community call, please sign up in Julia slack channel by DM Roger-luo your email address. Or follow our twitter.

If you have anything interesting to share up to 40min, or just want to talk about your experience in a brief 10min, let us know! Please sign up with a topic using this Google sheet.

Communication

Github issues: Please feel free to ask questions and report bugs, feature request in issues
Slack: you can join julia's slack channel and ask Yao related questions in #yao-dev channel.
Julia discourse: You can also ask questions on julia discourse or the Chinese discourse

The Team

This project is an effort of QuantumBFS, an open source organization for quantum science. Yao is currently maintained by Xiu-Zhe (Roger) Luo and Jin-Guo Liu with contributions from open source community. All the contributors are listed in the contributors.

Cite Yao

If you use Yao in teaching and research, please cite our work:

@article{YaoFramework2019,
  title={Yao.jl: Extensible, Efficient Framework for Quantum Algorithm Design},
  author={Xiu-Zhe Luo and Jin-Guo Liu and Pan Zhang and Lei Wang},
  journal={arXiv preprint arXiv:1912.10877},
  year={2019}
}

License

Yao is released under the Apache 2 license.