-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Background.md draft #962
Background.md draft #962
Conversation
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #962 +/- ##
=======================================
Coverage 89.91% 89.91%
=======================================
Files 110 110
Lines 8129 8129
=======================================
Hits 7309 7309
Misses 820 820 ☔ View full report in Codecov by Sentry. |
This sounds good to me; we don't need to be very detailed here; we can direct things to @plquera's book in the background section. All we need is a quick explanation of the acronyms and equations (e.g., what we are simulating/running). PS. I forgot to mention that the main purpose of this is to give a quick explanation when a user sees a physics acronym in other parts of the documentation. So ideally, we want to cover a wider range of concepts but not go into the details here. Then you can guide people to read the book (or other references) for more explanation |
Sounds good! I think the topics the background covers so far are the ones that we expect to link back to the revised I went ahead and put references towards the qbook. In the spirit of keeping things short in the background I imagine the docstrings, (when we get to revising them) will provide more detail as to how exactly to accomplish what's defined in the background (e.g. non-uniform local control). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overall looks good just make sure to emphasize the words that appear in the builder syntax so that it reenforces the bloqade API.
Co-authored-by: Phillip Weinberg <[email protected]>
Co-authored-by: Phillip Weinberg <[email protected]>
Co-authored-by: Phillip Weinberg <[email protected]>
are we adding the links to background in quick start in this PR or next PR? the content itself LGTM |
I'll add the links in this PR (: I don't think that will cause the PR to be too large for reasonable review |
This is admittedly sparser than I would hope and should certainly go under further revisions but there are two things I'm thinking of adding:
.rydberg
and.rabi
be a better place?I also had a talk with @weinbe58 and he thought it best not to really mention
.hyperfine
considering it's not very actively shown/talked about.