Closed johnzl-777 closed 4 months ago
PR Preview Action v1.4.7 :---: Preview removed because the pull request was closed. 2024-05-30 15:45 UTC
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 89.91%. Comparing base (
d627b19
) to head (3efdb29
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
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 index.md
and quick_start.md
. More than willing to add more if you think these topics are currently not enough.
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).
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.