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

AQT doc devices and getting started tutorial #3420

Merged
merged 12 commits into from Oct 20, 2020

Conversation

alfrisch
Copy link

This PR adds AQT documentation and contains a *.md describing how to retreive tokens and URLs of AQT devices and a Jupyter notebook on a simple getting started example which shows how to execute a basic quantum circuit via the AQT API.

@google-cla google-cla bot added the cla: yes Makes googlebot stop complaining. label Oct 15, 2020
Copy link
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thank you! I added some comments.
Also, a couple more things:

  1. we'll need to add the headers to book.yaml
  2. and to readthedocs rtd_docs/index.rst.
  3. I'd love to have Access and Authentication separated out into the Guides section that would explain the users where they can sign up and then point them to the tutorial. We'll have similar ones for Pasqal and Google as well. Basically some of the sentences from the top section of your Getting Started guide but with a little bit more explanation what they can expect - e.g. I managed to sign up with my Google account and requested a subscription (the interface was clear), but it is unclear when how I will get a token.

Edit: I just realized this was exactly the content of devices.md. I would rename devices.md to access.md and rename the title to Access and authentication.

I'm happy to add 1 and 2 if you're okay with me pushing to your branch.

docs/tutorials/aqt/getting_started.ipynb Outdated Show resolved Hide resolved
docs/aqt/devices.md Outdated Show resolved Hide resolved
docs/aqt/devices.md Outdated Show resolved Hide resolved
Co-authored-by: Balint Pato <balopat@users.noreply.github.com>
@alfrisch
Copy link
Author

I'm happy to add 1 and 2 if you're okay with me pushing to your branch.

sure, go ahead, you can push to my branch

@google-cla
Copy link

google-cla bot commented Oct 19, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added cla: no and removed cla: yes Makes googlebot stop complaining. labels Oct 19, 2020
@alfrisch
Copy link
Author

@googlebot I fixed it.

@google-cla google-cla bot added cla: yes Makes googlebot stop complaining. and removed cla: no labels Oct 19, 2020
Copy link
Author

@alfrisch alfrisch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes have been added

Copy link
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I added a next steps section as well that points to the getting started guide.

@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Oct 19, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Oct 19, 2020
@CirqBot
Copy link
Collaborator

CirqBot commented Oct 19, 2020

Automerge cancelled: A required status check is not present.

Missing statuses: ['cla/google']

@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Oct 19, 2020
@balopat balopat removed the cla: yes Makes googlebot stop complaining. label Oct 19, 2020
@balopat balopat added cla: yes Makes googlebot stop complaining. and removed cla: yes Makes googlebot stop complaining. labels Oct 19, 2020
@balopat
Copy link
Contributor

balopat commented Oct 19, 2020

@googlebot please rescan

@balopat balopat added cla: yes Makes googlebot stop complaining. automerge Tells CirqBot to sync and merge this PR. (If it's running.) labels Oct 19, 2020
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Oct 20, 2020
@CirqBot CirqBot merged commit d787f5a into quantumlib:master Oct 20, 2020
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Oct 20, 2020
@balopat balopat added the kind/docs Documentation related problems, ideas, requests label Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining. kind/docs Documentation related problems, ideas, requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants