From 5b2ee3050be87a3f7b5e14651d2a51dc2ba44e36 Mon Sep 17 00:00:00 2001 From: v2rockets Date: Wed, 12 Jun 2024 08:23:44 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8af933e..20b01dd 100644 --- a/README.md +++ b/README.md @@ -4,56 +4,63 @@ [![](https://img.shields.io/github/release/ScQ-Cloud/pyquafu.svg?style=popout-square)](https://github.com/ScQ-Cloud/pyquafu/releases) [![](https://img.shields.io/pypi/dm/pyquafu?style=popout-square)](https://pypi.org/project/pyquafu/) - -Python toolkit for submitting quantum circuits on the superconducting quantum computing cloud [Quafu](http://quafu.baqis.ac.cn/). - +A Python toolkit for submitting quantum circuits to the superconducting quantum computing cloud [Quafu](http://quafu.baqis.ac.cn/). ## Introduction -**PyQuafu** is developed for the users of [Quafu](http://quafu.baqis.ac.cn/) to construct, compile and execute quantum circuits on real quantum devices. One can use PyQuafu to interact with different quantum backends provides by the experimental group of [Quafu](http://quafu.baqis.ac.cn/). +**PyQuafu** is designed for users of [Quafu](http://quafu.baqis.ac.cn/) to construct, compile, and execute quantum circuits on real quantum devices. With PyQuafu, you can interact with various quantum backends provided by the experimental group at [Quafu](http://quafu.baqis.ac.cn/). ## Installation -You can directly install via PyPI, +### Install via PyPI -``` +You can install PyQuafu directly from PyPI: + +```bash pip install pyquafu ``` -or build from source +### Build from Source -``` +Alternatively, you can build PyQuafu from the source: + +```bash pip install -r requirements.txt python setup.py install ``` -Note that we visualize DAG(directed acyclic graph) through python package ``graphviz``. And if you need it, make sure [Graphviz software](https://graphviz.org/) being installed on your system. Refer to [graphviz · PyPI](https://pypi.org/project/graphviz/#description) for installation guidance. +### Graphviz Dependency -## GPU support -To install PyQuafu with GPU-based circuit simulator, you need build from the source and make sure that [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) is installed. You can run +If you need to visualize Directed Acyclic Graphs (DAGs), ensure that the [Graphviz software](https://graphviz.org/) is installed on your system. Refer to the [graphviz · PyPI](https://pypi.org/project/graphviz/#description) page for installation guidance. -``` +### GPU Support + +To install PyQuafu with GPU-based circuit simulation, you need to build from the source and ensure that the [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) is installed. Use the following command to install the GPU version: + +```bash python setup.py install -DUSE_GPU=ON ``` -to install the GPU version. If you further have [cuQuantum](https://developer.nvidia.com/cuquantum-sdk) installed, you can install PyQuafu with cuQuantum support. -``` + +If you also have [cuQuantum](https://developer.nvidia.com/cuquantum-sdk) installed, you can install PyQuafu with cuQuantum support: + +```bash python setup.py install -DUSE_GPU=ON -DUSE_CUQUANTUM=ON ``` +## Documentation -## Document -Please see the website [docs](https://scq-cloud.github.io/). +For detailed documentation about usage, please visit the [PyQuafu documentation website](https://scq-cloud.github.io/). -## Note -If you are using an Apple silicon Mac and meet the error "illegal hardware instruction", please confirm whether you have updated to the arm64 version of Anaconda (see https://github.com/abess-team/abess/issues/310). +## Note for Apple Silicon Mac Users -## Examples +If you encounter the error "illegal hardware instruction" on an Apple silicon Mac, ensure that you have updated to the arm64 version of Anaconda. See [this issue](https://github.com/abess-team/abess/issues/310) for more details. -### 1.quantum_rl +## Examples -The example shows quantum reinforcement learning interacts with Quafu to solve CartPole environment. +### Quantum Reinforcement Learning -Refer to https://github.com/enchanted123/quantum-RL-with-quafu for more details. +This example demonstrates how quantum reinforcement learning interacts with Quafu to solve the CartPole environment. For more details, refer to the [quantum-RL-with-quafu repository](https://github.com/enchanted123/quantum-RL-with-quafu). ## Author + This project is developed by the quantum cloud computing team at the Beijing Academy of Quantum Information Sciences. From b06dde3f0b54f6f251cab171b4e7506a2041438d Mon Sep 17 00:00:00 2001 From: v2rockets Date: Thu, 13 Jun 2024 02:32:03 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20b01dd..b6db4a4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A Python toolkit for submitting quantum circuits to the superconducting quantum ## Introduction -**PyQuafu** is designed for users of [Quafu](http://quafu.baqis.ac.cn/) to construct, compile, and execute quantum circuits on real quantum devices. With PyQuafu, you can interact with various quantum backends provided by the experimental group at [Quafu](http://quafu.baqis.ac.cn/). +**PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) with Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from (http://quafu.baqis.ac.cn/). ## Installation From 4e2a059d7db1a914f42627e91c78311497cfd8cb Mon Sep 17 00:00:00 2001 From: v2rockets Date: Thu, 13 Jun 2024 02:32:26 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b6db4a4..18f6125 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A Python toolkit for submitting quantum circuits to the superconducting quantum ## Introduction -**PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) with Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from (http://quafu.baqis.ac.cn/). +**PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) with Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from [Quafu](http://quafu.baqis.ac.cn/). ## Installation From f3f8e4150cd3faed8160846f2f66f40c2f9e7eb4 Mon Sep 17 00:00:00 2001 From: v2rockets Date: Thu, 13 Jun 2024 02:33:15 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 18f6125..25f73b7 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ [![](https://img.shields.io/github/release/ScQ-Cloud/pyquafu.svg?style=popout-square)](https://github.com/ScQ-Cloud/pyquafu/releases) [![](https://img.shields.io/pypi/dm/pyquafu?style=popout-square)](https://pypi.org/project/pyquafu/) -A Python toolkit for submitting quantum circuits to the superconducting quantum computing cloud [Quafu](http://quafu.baqis.ac.cn/). - ## Introduction **PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) with Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from [Quafu](http://quafu.baqis.ac.cn/). From b9043eedba1cbb02394c5226007cfc6272121e32 Mon Sep 17 00:00:00 2001 From: v2rockets Date: Thu, 13 Jun 2024 02:35:53 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 25f73b7..6558175 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Introduction -**PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) with Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from [Quafu](http://quafu.baqis.ac.cn/). +**PyQuafu** is designed for users to construct, compile, and execute quantum circuits on quantum devices on [Quafu](http://quafu.baqis.ac.cn/) using Python. With PyQuafu, you can interact with various real quantum backends provided by the experimental group from [Quafu](http://quafu.baqis.ac.cn/). ## Installation