Skip to content

Neutron Scattering Tutorial Function + AQC Function Template - #5501

Open
pdd23001 wants to merge 3 commits into
Qiskit:mainfrom
pdd23001:aqc-trotter-neutron-scattering
Open

Neutron Scattering Tutorial Function + AQC Function Template#5501
pdd23001 wants to merge 3 commits into
Qiskit:mainfrom
pdd23001:aqc-trotter-neutron-scattering

Conversation

@pdd23001

Copy link
Copy Markdown

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 also
cross-link each other by docs path rather than by filename. GitHub and arXiv links stay
absolute, as do the https://quantum.cloud.ibm.com dashboard links (matching how the other
guides do it).

Registration. I've added entries to docs/tutorials/_toc.json and docs/tutorials/index.mdx
for 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 and
Hamiltonian simulation templates) and a version-info cell, which check-for-version-info-cells
requires for docs/guides/*.ipynb. I put the template notebook in guides since other templates were there as well

Notebook testing. Both are in [groups.exclude] in scripts/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.ipynb and
docs/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 @kevinsung and
@nathanearnestnoble for the neutron scattering tutorial, and @jenglick, @garrison,
@beckykd for the Hamiltonian simulation template.

Checks. ./check passes all 8. I also ran check:katex-render (clean) and
check:stale-images (clean). Note the diff includes 4 extracted plot images under
public/docs/images/tutorials/..., which the notebook normalizer pulled out of the notebook
outputs.

Hardware Example Outputs in the template notebook in guides are left will soon put them in!

@pdd23001
pdd23001 requested a review from a team August 11, 2026 20:53
@qiskit-bot

Copy link
Copy Markdown
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:

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants