Extensible, Efficient Quantum Algorithm Design for Humans.
Author QuantumBFS
534 Stars
Updated Last
1 Year Ago
Started In
April 2018
Yao Logo

Unitary Fund

Yao YaoBlocks YaoArrayRegister YaoSym
CI Build Status Build Status Build Status
Codecov Codecov Codecov Codecov

Yao Extensible, Efficient Quantum Algorithm Design for Humans.


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)


Yao is a   Julia Language   package. To install Yao, please open Julia's interactive session (known as REPL) and press ] key in the REPL to use the package mode, then type the following command

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.


Tutorial | Learning Yao by Examples

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.



Please read our contribution guide.

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:

  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},


Yao is released under the Apache 2 license.