Skip to content
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

Merged
merged 9 commits into from
May 30, 2024
Merged

Background.md draft #962

merged 9 commits into from
May 30, 2024

Conversation

johnzl-777
Copy link
Collaborator

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:

  1. @plquera has done a lot of work explaining similar things in his qbook. I'm inclined to provide links to the relevant sections for any newcomers who want a deeper explanation.
  2. I don't really have any code examples and I'm uncertain if this is the right place to put them. Would the docstrings of things like .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.

@johnzl-777 johnzl-777 requested a review from Roger-luo May 28, 2024 20:47
Copy link
Contributor

github-actions bot commented May 28, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-30 15:45 UTC

Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.91%. Comparing base (d627b19) to head (3efdb29).

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.
📢 Have feedback on the report? Share it here.

@Roger-luo
Copy link
Member

Roger-luo commented May 28, 2024

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

docs/home/background.md Outdated Show resolved Hide resolved
@johnzl-777
Copy link
Collaborator Author

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

Copy link
Member

@weinbe58 weinbe58 left a 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.

docs/home/background.md Outdated Show resolved Hide resolved
docs/home/background.md Outdated Show resolved Hide resolved
docs/home/background.md Outdated Show resolved Hide resolved
@Roger-luo
Copy link
Member

Roger-luo commented May 30, 2024

are we adding the links to background in quick start in this PR or next PR? the content itself LGTM

@johnzl-777
Copy link
Collaborator Author

I'll add the links in this PR (: I don't think that will cause the PR to be too large for reasonable review

@johnzl-777 johnzl-777 enabled auto-merge (squash) May 30, 2024 15:41
@johnzl-777 johnzl-777 merged commit 322f476 into main May 30, 2024
10 checks passed
@johnzl-777 johnzl-777 deleted the john/add-background branch May 30, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants