Skip to content

Commit af3ffda

Browse files
authored
Expand and embellish README file (#1601)
* Add "Citation" section to README * Remove trailing whitespace In Markdown, two trailing spaces on a line are a shorthand way to indicate a forced line break. This is prone to causing problems accidentally, so as a safety precaution, it's a good idea to remove any whitespace at the ends of lines. * Add required Google disclaimer & also contact info Google requires the text of this disclaimer in project README files for open-source projects. * Add QAI logo to bottom of README file It's pretty, and it's good for branding. * Add Qualtran logo files * Edit, expand, and embellish README file Changes: * Add required Google disclaimer * Add new "Usage", "News" & "Contact" sections * Move some text around * Use GitHub Markdown syntax for warning boxes * Add a TOC line near the top, for rapid access * Add logos and badges, for some extra visual flair * Add HTML anchor for "how-to-cite" The section "How to cite" appears in a number of other Quantumlib READMEs, and URLs referencing #how-to-cite exist in some documens, so for maximum compatibility, let's add an additional anchor for links. * Change smallcaps to normal font * Change section News → Community & add more content * Remove mention about the GUI Per [review comment by @mpharrigan](#1601 (comment)), removing the mention of the physical resources estimation GUI. * Following up on suggestion to put Qualtran title in comment Following up on a suggestion in a [review comment by @mpharrigan](#1601 (comment)) to put the Qualtran title in comment at the top of the file. * Replace separate dark/light logo files with one combined SVG Using a trick from https://stackoverflow.com/a/67190894/743730, we can create a single SVG that will change text colors depending on whether the user is using dark mode or light mode on GitHub. * Switch to new single SVG logo file * Remove statement about Qualtran being an abbreviation Because it isn't.
1 parent 1ed1444 commit af3ffda

File tree

3 files changed

+372
-27
lines changed

3 files changed

+372
-27
lines changed

README.md

+124-27
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,156 @@
1-
# Qᴜᴀʟᴛʀᴀɴ
1+
<!-- # Qualtran (title omitted because our logo acts as the title) -->
22

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>
66

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.
108

11-
Subscribe to [[email protected]](https://groups.google.com/g/qualtran-announce)
12-
to receive the latest news and updates!
9+
[![Licensed under the Apache 2.0 open-source license](https://img.shields.io/badge/License-Apache%202.0-3c60b1.svg?logo=opensourceinitiative\&logoColor=white\&style=flat-square)](https://github.com/quantumlib/qualtran/blob/main/LICENSE)
10+
[![Compatible with Python versions 3.10 and higher](https://img.shields.io/badge/Python-3.10+-6828b2.svg?style=flat-square&logo=python&logoColor=white)](https://www.python.org/downloads/)
11+
[![Qualtran project on PyPI](https://img.shields.io/pypi/v/qualtran.svg?logo=python&logoColor=white&label=PyPI&style=flat-square&color=9d3bb8)](https://pypi.org/project/qualtran)
1312

14-
## Documentation
13+
[Installation](#installation) &ndash;
14+
[Usage](#usage) &ndash;
15+
[Documentation](#documentation) &ndash;
16+
[Community](#community) &ndash;
17+
[Citation](#citation) &ndash;
18+
[Contact](#contact)
19+
20+
</div>
1521

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.
1724

1825
## Installation
1926

20-
Qualtran is being actively developed. We recommend installing from source:
27+
Qualtran is being actively developed. We recommend installing from the source code.
2128

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:
2331

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+
```
2737

2838
You can also install the latest tagged release using `pip`:
2939

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/.
3171

32-
You can also install the latest state of the main branch:
72+
## Community
3373

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].
3577

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
3780

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
3982

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:
4284

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.
4490

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
4795

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
49125
@misc{harrigan2024qualtran,
50126
title={Expressing and Analyzing Quantum Algorithms with Qualtran},
51127
author={Matthew P. Harrigan and Tanuj Khattar
52128
and Charles Yuan and Anurudh Peduri and Noureldin Yosri
53129
and Fionn D. Malone and Ryan Babbush and Nicholas C. Rubin},
54130
year={2024},
55131
eprint={2409.04643},
132+
archivePrefix={arXiv},
133+
primaryClass={quant-ph},
56134
doi={10.48550/arXiv.2409.04643},
57135
url={https://arxiv.org/abs/2409.04643},
58136
}
59137
```
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

Comments
 (0)