Skip to content

Add document how to use pytket-braket#184

Open
yoshi-qc wants to merge 11 commits into
mainfrom
yoshi/issue-183
Open

Add document how to use pytket-braket#184
yoshi-qc wants to merge 11 commits into
mainfrom
yoshi/issue-183

Conversation

@yoshi-qc

Copy link
Copy Markdown
Contributor

Description

Add an example notebook including how to use local emulator , cloud emulator, Rigetti device, IQM device, and IonQ device.

Related issues

#183

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

yoshi-qc added 3 commits May 15, 2025 21:22
The notebook includes how to use local emulator , cloud emulator, Rigetti device, IQM device, and IonQ device.
@yoshi-qc yoshi-qc requested a review from cqc-alec as a code owner May 15, 2025 12:31
@CalMacCQ

Copy link
Copy Markdown
Contributor

Thanks Yoshi, I'm happy to review this

@yoshi-qc

Copy link
Copy Markdown
Contributor Author

This conflicts with #61.

@yoshi-qc yoshi-qc closed this May 15, 2025
@yoshi-qc yoshi-qc reopened this May 15, 2025
@CalMacCQ

Copy link
Copy Markdown
Contributor

This conflicts with #61.

#61 is an old PR. I think its fine to start from scratch.

@yoshi-qc

Copy link
Copy Markdown
Contributor Author

Sorry for my misunderstanding. I reopen #184

@cqc-alec cqc-alec requested review from CalMacCQ and removed request for cqc-alec May 15, 2025 12:38

@CalMacCQ CalMacCQ left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! Thanks for working on this Yoshi.

We should resolve what do to about the executed cells. There are also some minor changes I have suggested.

If you do git pull from this branch you should get the changes I've made into your local environment.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe this notebook file should have a shorter name

Something like braket_backend_usage.ipynb? I'll leave it up to you. The name will also need to be updated in the index.rst file.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Rename to braket_backend_usage.ipynb and update the index.rst file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This notebook will make external calls to remote backends when trying to access the Rigetti, IONQ and other devices.

I think its still very useful to show the API for accessing the remote backends in this example.

I can think of two solutions

  1. Switch off execution for this notebook and only show cell inputs.
  2. Separate the remote backends into another notebook file. I can then manually exclude this remote_backends.ipynb file from execution in the sphinx configuration.

I think I prefer 2. What do you think?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Either option is okey for me. Could you support the creation?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this example notebook should start with a paragraph (or bullet point list) summarising all of the available backends.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Add information of available backend at the beginning of the notebook.

CalMacCQ and others added 5 commits May 28, 2025 12:21
Update the notebook name to braket_backend_usage.ipynb
Add information for the available backends
Update region information for SV, TN, and DM on AWS cloud.
@cqc-melf

cqc-melf commented Feb 2, 2026

Copy link
Copy Markdown
Collaborator

Are you still working on this or can we close it?

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