Neutron Scattering Tutorial Function + AQC Function Template - #5501
Open
pdd23001 wants to merge 3 commits into
Open
Neutron Scattering Tutorial Function + AQC Function Template#5501pdd23001 wants to merge 3 commits into
pdd23001 wants to merge 3 commits into
Conversation
Contributor
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 One or more of the following people are relevant to this code:
|
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@henryzou50 Please review whenever you get the chance!
Internal links converted to root-relative in both notebooks.
/docs/guides/serverless,/docs/guides/intro-to-patterns,/docs/guides/error-mitigation-and-suppression-techniques,/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp,/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#save_account,/docs/tutorials/simulate-neutron-scattering, and/learning/courses/utility-scale-quantum-computing/quantum-simulation. The two notebooks alsocross-link each other by docs path rather than by filename. GitHub and arXiv links stay
absolute, as do the
https://quantum.cloud.ibm.comdashboard links (matching how the otherguides do it).
Registration. I've added entries to
docs/tutorials/_toc.jsonanddocs/tutorials/index.mdxfor the tutorial. The template notebook is a guide rather than a tutorial, so it also needed
docs/guides/_toc.json(under "Qiskit Function templates", alongside the chemistry andHamiltonian simulation templates) and a
version-infocell, whichcheck-for-version-info-cellsrequires for
docs/guides/*.ipynb. I put the template notebook in guides since other templates were there as wellNotebook testing. Both are in
[groups.exclude]inscripts/config/notebook-testing.toml,with a comment noting they need saved credentials and a deployed Qiskit Function, so they can't
run in CI. Same treatment as
docs/tutorials/simulate-neutron-scattering.ipynbanddocs/guides/function-template-hamiltonian-simulation.ipynb.qiskit_bot.yaml— needs your input. I've listed only myself as the owner of both pages,since I didn't want to add anyone else's handle without asking. Happy to add reviewers or SMEs;
just tell me who should be on there. For reference, the sibling pages list
@kevinsungand@nathanearnestnoblefor the neutron scattering tutorial, and@jenglick,@garrison,@beckykdfor the Hamiltonian simulation template.Checks.
./checkpasses all 8. I also rancheck:katex-render(clean) andcheck:stale-images(clean). Note the diff includes 4 extracted plot images underpublic/docs/images/tutorials/..., which the notebook normalizer pulled out of the notebookoutputs.
Hardware Example Outputs in the template notebook in guides are left will soon put them in!