-
Notifications
You must be signed in to change notification settings - Fork 127
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
Comments
Hello @coruscating, can I work on this issue? |
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 |
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? |
How many experiments do you want to add the code snippet? |
@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. |
…3.yaml (Qiskit-Extensions#1238)
…periments into main local/main updated (Qiskit-Extensions#1238)
…periments local/main updated (Qiskit-Extensions#1238)
…periments into issue-1238 local/issue-1238 update (Qiskit-Extensions#1238)
…/qiskit-experiments into issue-qiskit-community#1238 local/issue-#1238 update
…kit-Extensions#1238)
…Qiskit-Extensions#1238)
…/qiskit-experiments into issue-qiskit-community#1238 update local/issue-#1238
Hello @coruscating, I have accidentally clicked the button on assignees, and unassigned myself. |
@Naohnakazawa Yes, of course. Reassigned you, thanks. |
…kazawa/qiskit-experiments into issue-qiskit-community#1238-draft update local/qiskit-#1238-draft
…eriments into issue-qiskit-community#1238-draft update /local/issue-#1238-draft
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2
…kazawa/qiskit-experiments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with origin/issue-#1238-draft
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with upstream/main
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with upstream/main
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with upstream/main
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with upstream/main
…eriments into issue-qiskit-community#1238-draft2 update local2/issue-#1238-draft2 with upstream/main
Following the template in #1221, add minimal working code examples for all experiments for ease of use.
The text was updated successfully, but these errors were encountered: