From 2b25abdff39e685ad5be5fbcfe54c78c9a1d69bd Mon Sep 17 00:00:00 2001 From: Rogerluo Date: Wed, 6 Jun 2018 01:47:03 +0800 Subject: [PATCH 1/3] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e08b56e67..6e7cfe826 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,13 @@ Flexible, Extensible, Efficient Framework for Quantum Algorithm Design. ## Project Goals +Quantum computing is approaching. However, in the near term future, we will not be able to directly test our algorithm on a real quantum computer. Moreover, the way for quantum programming is still under development. We will need a classical playground to let us explore the world of quantum algorithms, quantum programming and even quantum information. Furthermore, recently progress on self-adaptive quantum algorithms like QAOA, quantum circuit born machines, etc. can not be analysed directly by theoretical tools, and they require numerical simulation. + +Our framework, Yao, aims to provide flexible utilities for simulating your own algorithms, which means you should be able to simulate your quantum algorithm with any possible numerical approach that maximize the machine performance without making everything a black box. We provide hierachical APIs for different development purpose. + ## Installation -The package is not registered yet. +The package is registering. Use this command in REPL to add it at the moment. ```julia julia> Pkg.clone("https://github.com/QuantumBFS/Yao.jl.git") @@ -21,5 +25,5 @@ julia> Pkg.clone("https://github.com/QuantumBFS/Yao.jl.git") ## Documentation -- [**STABLE**]() +- [**STABLE**](https://quantumbfs.github.io/Yao.jl/stable) - [**LATEST**](https://quantumbfs.github.io/Yao.jl/latest) From 568c71720fe39a40acc4450dc769b78581874982 Mon Sep 17 00:00:00 2001 From: Rogerluo Date: Wed, 6 Jun 2018 01:50:38 +0800 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6e7cfe826..3f0f7cc49 100644 --- a/README.md +++ b/README.md @@ -25,5 +25,7 @@ julia> Pkg.clone("https://github.com/QuantumBFS/Yao.jl.git") ## Documentation +The documentation is under development. There is only a few demos at the moment. + - [**STABLE**](https://quantumbfs.github.io/Yao.jl/stable) - [**LATEST**](https://quantumbfs.github.io/Yao.jl/latest) From 81ed26d10266e8670c4e013a4923be595447ab3c Mon Sep 17 00:00:00 2001 From: Rogerluo Date: Wed, 6 Jun 2018 01:53:54 +0800 Subject: [PATCH 3/3] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f0f7cc49..6f0bbf8b3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,11 @@ Flexible, Extensible, Efficient Framework for Quantum Algorithm Design. Quantum computing is approaching. However, in the near term future, we will not be able to directly test our algorithm on a real quantum computer. Moreover, the way for quantum programming is still under development. We will need a classical playground to let us explore the world of quantum algorithms, quantum programming and even quantum information. Furthermore, recently progress on self-adaptive quantum algorithms like QAOA, quantum circuit born machines, etc. can not be analysed directly by theoretical tools, and they require numerical simulation. -Our framework, Yao, aims to provide flexible utilities for simulating your own algorithms, which means you should be able to simulate your quantum algorithm with any possible numerical approach that maximize the machine performance without making everything a black box. We provide hierachical APIs for different development purpose. +Our framework, Yao, aims to provide flexible utilities for simulating your own algorithms, which means you should be able to simulate your quantum algorithm with any possible numerical approach that maximize the machine performance without making everything a black box. We provide hierachical APIs for different development purpose. By overloading interfaces and defining new subtypes you will be able to create whatever you want for your simulation. + +## Contribution + +We do not accept PR at the moment. But if there is any comments please leave us an issue. We will start accepting PRs after v0.2. ## Installation