|
1 |
| -# Qᴜᴀʟᴛʀᴀɴ |
| 1 | +<!-- # Qualtran (title omitted because our logo acts as the title) --> |
2 | 2 |
|
3 |
| -Qᴜᴀʟᴛʀᴀɴ (quantum algorithms translator) is a set of abstractions for representing quantum |
4 |
| -programs and a library of quantum algorithms expressed in that language to support quantum |
5 |
| -algorithms research. |
| 3 | +<div align="center"> |
| 4 | +<img alt="Qualtran logo" width="340px" src="docs/_static/qualtran-logo-mode-sensitive.svg"> |
| 5 | +<br> |
6 | 6 |
|
7 |
| -**Note:** Qualtran is an experimental preview release. We provide no backwards compatibility |
8 |
| -guarantees. Some algorithms or library functionality may be incomplete or contain inaccuracies. |
9 |
| -Open issues or contact the authors with bug reports or feedback. |
| 7 | +Python package for fault-tolerant quantum algorithms research. |
10 | 8 |
|
11 |
| -Subscribe to [[email protected]](https://groups.google.com/g/qualtran-announce) |
12 |
| -to receive the latest news and updates! |
| 9 | +[](https://github.com/quantumlib/qualtran/blob/main/LICENSE) |
| 10 | +[](https://www.python.org/downloads/) |
| 11 | +[](https://pypi.org/project/qualtran) |
13 | 12 |
|
14 |
| -## Documentation |
| 13 | +[Installation](#installation) – |
| 14 | +[Usage](#usage) – |
| 15 | +[Documentation](#documentation) – |
| 16 | +[Community](#community) – |
| 17 | +[Citation](#citation) – |
| 18 | +[Contact](#contact) |
| 19 | + |
| 20 | +</div> |
15 | 21 |
|
16 |
| -Documentation is available at https://qualtran.readthedocs.io/ |
| 22 | +Qualtran is a set of abstractions for representing quantum programs and a library of quantum |
| 23 | +algorithms expressed in that language to support quantum algorithms research. |
17 | 24 |
|
18 | 25 | ## Installation
|
19 | 26 |
|
20 |
| -Qualtran is being actively developed. We recommend installing from source: |
| 27 | +Qualtran is being actively developed. We recommend installing from the source code. |
21 | 28 |
|
22 |
| -For a local editable copy: |
| 29 | +The following commands will clone a copy of the repository, then install the Qualtran package in |
| 30 | +your local Python environment as a local editable copy: |
23 | 31 |
|
24 |
| - git clone https://github.com/quantumlib/Qualtran.git |
25 |
| - cd Qualtran/ |
26 |
| - pip install -e . |
| 32 | +```shell |
| 33 | +git clone https://github.com/quantumlib/Qualtran.git |
| 34 | +cd Qualtran/ |
| 35 | +pip install -e . |
| 36 | +``` |
27 | 37 |
|
28 | 38 | You can also install the latest tagged release using `pip`:
|
29 | 39 |
|
30 |
| - pip install qualtran |
| 40 | +```shell |
| 41 | +pip install qualtran |
| 42 | +``` |
| 43 | + |
| 44 | +You can also install the latest version of the main branch on GitHub: |
| 45 | + |
| 46 | +```shell |
| 47 | +pip install git+https://github.com/quantumlib/Qualtran |
| 48 | +``` |
| 49 | + |
| 50 | +## Usage |
| 51 | + |
| 52 | +> [!WARNING] |
| 53 | +> Qualtran is an experimental preview release. We provide no backwards compatibility guarantees. |
| 54 | +> Some algorithms or library functionality may be incomplete or contain inaccuracies. Open issues or |
| 55 | +> contact the authors with bug reports or feedback. |
| 56 | +
|
| 57 | +You should be able to import the `qualtran` package into your interactive Python environment as |
| 58 | +as well as your programs: |
| 59 | + |
| 60 | +```shell |
| 61 | +import qualtran |
| 62 | +``` |
| 63 | + |
| 64 | +If this is successful, you can move on to learning how to |
| 65 | +[write bloqs](https://qualtran.readthedocs.io/en/latest/_infra/Bloqs-Tutorial.html) or investigate |
| 66 | +the [bloqs library](https://qualtran.readthedocs.io/en/latest/bloqs/index.html#bloqs-library). |
| 67 | + |
| 68 | +## Documentation |
| 69 | + |
| 70 | +Documentation is available at https://qualtran.readthedocs.io/. |
31 | 71 |
|
32 |
| -You can also install the latest state of the main branch: |
| 72 | +## Community |
33 | 73 |
|
34 |
| - pip install git+https://github.com/quantumlib/Qualtran |
| 74 | +Qualtran's community is growing rapidly, and if you'd like to join the [many open-source |
| 75 | +contributors] to the Qualtran project, we welcome your participation! We are dedicated to |
| 76 | +cultivating an open and inclusive community, and have a [code of conduct]. |
35 | 77 |
|
36 |
| -## Physical Resource Estimation GUI |
| 78 | +[many open-source contributors]: https://github.com/quantumlib/Qualtran/graphs/contributors |
| 79 | +[code of conduct]: https://github.com/quantumlib/Qualtran/blob/main/CODE_OF_CONDUCT.md |
37 | 80 |
|
38 |
| -Qualtran provides a GUI for estimating the physical resources (qubits, magic states, runtime, ..etc) needed to run a quantum algorithm. The GUI can be run locally by running: |
| 81 | +### Announcements |
39 | 82 |
|
40 |
| - cd $QUALTRAN_HOME |
41 |
| - python -m qualtran.surface_code.ui |
| 83 | +You can stay on top of Qualtran news using the approach that best suits your needs: |
42 | 84 |
|
43 |
| -## Citation |
| 85 | +* For releases and major announcements: join the low-volume mailing list [`qualtran-announce`]. |
| 86 | +* For releases only: |
| 87 | + * *Via GitHub notifications*: configure [repository notifications] for Qualtran. |
| 88 | + * *Via RSS from GitHub*: subscribe to the GitHub [Qualtran releases feed]. |
| 89 | + * *Via RSS from PyPI*: subscribe to the [PyPI releases feed] for Qualtran. |
44 | 90 |
|
45 |
| -When publishing articles or otherwise writing about Qualtran, please cite the |
46 |
| -following: |
| 91 | +[`qualtran-announce`]: https://groups.google.com/g/qualtran-announce |
| 92 | +[repository notifications]: https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/configuring-notifications |
| 93 | +[Qualtran releases feed]: https://github.com/quantumlib/Qualtran/releases.atom |
| 94 | +[PyPI releases feed]: https://pypi.org/rss/project/qualtran/releases.xml |
47 | 95 |
|
48 |
| -```latex |
| 96 | +### Questions and Discussions |
| 97 | + |
| 98 | +* If you'd like to ask questions and participate in discussions, join the [`qualtran-dev`] |
| 99 | + group/mailing list. By joining [`qualtran-dev`], you will also get automated invites to the |
| 100 | + biweekly _Qualtran Sync_ meeting (below). |
| 101 | + |
| 102 | +* Would you like to get more involved in Qualtran development? The biweekly _Qualtran Sync_ |
| 103 | + is a virtual face-to-face meeting of contributors to discuss everything from issues to |
| 104 | + ongoing efforts, as well as to ask questions. Become a member of [`qualtran-dev`] to get |
| 105 | + an automatic meeting invitation! |
| 106 | + |
| 107 | +[`qualtran-dev`]: https://groups.google.com/g/qualtran-dev |
| 108 | + |
| 109 | +### Issues and Pull Requests |
| 110 | + |
| 111 | +* Do you have a feature request or want to report a bug? [Open an issue on |
| 112 | + GitHub] to report it! |
| 113 | +* Do you have a code contribution? Read our [contribution guidelines], then |
| 114 | + open a [pull request]! |
| 115 | + |
| 116 | +[Open an issue on GitHub]: https://github.com/quantumlib/Qualtran/issues/new/choose |
| 117 | +[contribution guidelines]: https://github.com/quantumlib/Qualtran/blob/main/CONTRIBUTING.md |
| 118 | +[pull request]: https://help.github.com/articles/about-pull-requests |
| 119 | + |
| 120 | +## Citation<a name="how-to-cite"></a> |
| 121 | + |
| 122 | +When publishing articles or otherwise writing about Qualtran, please cite the following: |
| 123 | + |
| 124 | +```bibtex |
49 | 125 | @misc{harrigan2024qualtran,
|
50 | 126 | title={Expressing and Analyzing Quantum Algorithms with Qualtran},
|
51 | 127 | author={Matthew P. Harrigan and Tanuj Khattar
|
52 | 128 | and Charles Yuan and Anurudh Peduri and Noureldin Yosri
|
53 | 129 | and Fionn D. Malone and Ryan Babbush and Nicholas C. Rubin},
|
54 | 130 | year={2024},
|
55 | 131 | eprint={2409.04643},
|
| 132 | + archivePrefix={arXiv}, |
| 133 | + primaryClass={quant-ph}, |
56 | 134 | doi={10.48550/arXiv.2409.04643},
|
57 | 135 | url={https://arxiv.org/abs/2409.04643},
|
58 | 136 | }
|
59 | 137 | ```
|
| 138 | + |
| 139 | +## Contact |
| 140 | + |
| 141 | +For any questions or concerns not addressed here, please email [email protected]. |
| 142 | + |
| 143 | +## Disclaimer |
| 144 | + |
| 145 | +This is not an officially supported Google product. |
| 146 | +This project is not eligible for the [Google Open Source Software Vulnerability Rewards |
| 147 | +Program](https://bughunters.google.com/open-source-security). |
| 148 | + |
| 149 | +Copyright 2025 Google LLC. |
| 150 | + |
| 151 | +<div align="center"> |
| 152 | + <a href="https://quantumai.google"> |
| 153 | + <img width="15%" alt="Google Quantum AI" |
| 154 | + src="./docs/_static/quantum-ai-vertical.svg"> |
| 155 | + </a> |
| 156 | +</div> |
0 commit comments