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

Minimal working code example in experiment API docs #1238

Open
coruscating opened this issue Jul 26, 2023 · 7 comments
Open

Minimal working code example in experiment API docs #1238

coruscating opened this issue Jul 26, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@coruscating
Copy link
Collaborator

Following the template in #1221, add minimal working code examples for all experiments for ease of use.

@coruscating coruscating added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 26, 2023
@Naohnakazawa
Copy link
Contributor

Hello @coruscating, can I work on this issue?

@Naohnakazawa
Copy link
Contributor

Hi @coruscating, if my understanding of this issue (and #1221) is correct, I have to add a ‘ #section: example ‘ and a sample code for the experiment( for example, T1) on the source(/library/characterization/t1.py). Even if it would help for user to do the experiment (T1), the information is duplicated because ‘#section: manual’ cites /manuals/characterization/t1. The use of :hide-code: means that the choice of the backend still remains in the source. I am happy if you have an alternative good idea?

@coruscating
Copy link
Collaborator Author

Yes, there will be a bit of duplicate code in the case where experiments have manuals, but most of the existing experiments don't have a separate manual. The purpose of this code example and the manual are also different: the example is meant to be a really quick code snippet that users can copy and paste to get an experiment running, whereas the manual is supposed to cover more advanced usage and detailed technical info about the experiment.

I think keeping the backend in the source and hiding it in the output is fine—we're only using simulators for documentation, so the idea is that users will instantiate their own backend on which to run the experiment. Do you have more concerns/ideas about this?

@Naohnakazawa
Copy link
Contributor

How many experiments do you want to add the code snippet?

@coruscating
Copy link
Collaborator Author

@Naohnakazawa Ideally all experiments, but if that's too much work at once, you can make a PR for a single category of experiments, for example all characterization experiments.

Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 3, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 4, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
…periments into issue-1238

local/issue-1238 update (Qiskit-Extensions#1238)
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Mar 28, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Apr 27, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Apr 30, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments Apr 30, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue May 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments May 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments May 2, 2024
Naohnakazawa referenced this issue in Naohnakazawa/qiskit-experiments May 2, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue May 2, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue May 10, 2024
@Naohnakazawa Naohnakazawa removed their assignment May 16, 2024
@Naohnakazawa
Copy link
Contributor

Hello @coruscating, I have accidentally clicked the button on assignees, and unassigned myself.
Can I continue working on this issue?

@coruscating
Copy link
Collaborator Author

@Naohnakazawa Yes, of course. Reassigned you, thanks.

Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue May 31, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Oct 24, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Oct 25, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Oct 26, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 7, 2024
…kazawa/qiskit-experiments into issue-qiskit-community#1238-draft

update local/qiskit-#1238-draft
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 14, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 14, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 14, 2024
…kazawa/qiskit-experiments into issue-qiskit-community#1238-draft2

update local2/issue-#1238-draft2 with origin/issue-#1238-draft
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 14, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 19, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Nov 27, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Dec 12, 2024
Naohnakazawa added a commit to Naohnakazawa/qiskit-experiments that referenced this issue Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants