QuScope

User Guide:

  • Installation
  • Quick Start
  • Tutorials
  • Examples

API Reference:

  • API Reference

Notebooks & Examples:

  • Notebook Gallery
    • Getting Started
    • Fully Quantum CTEM
    • Quantum STEM
    • Executed Reference Copies

Development:

  • Contributing
  • Changelog
  • License
QuScope
  • Notebook Gallery
  • View page source

Notebook Gallery

QuScope’s documentation is built around runnable Jupyter notebooks rather than hand-written prose — each notebook below imports the real quscope.quantum_ctem API and produces the figures shown. Start at the top and work down, or jump straight to the technique you need.

Getting Started

<no title>

Install check, backend basics (get_backend()), loading built-in materials (MoS₂, graphene), and a first quantum amplitude encoding of a small wavefunction.

<no title>

End-to-end MoS2Workflow and GrapheneWorkflow runs — structure visualization, simulation configuration, and CTEM image formation for two real 2D materials.

<no title>

Wavefunction encoding, QFT to momentum space, WPOA, and CTF modeling walked through step by step on a real abTEM-built graphene structure, using QuantumWaveFunction directly.

Fully Quantum CTEM

<no title>

The core CTEM pipeline: a single quantum circuit (state prep → QFT → phase-grating/lens diagonal gates → IQFT) implementing both single-slice WPOA and multislice CTEM, compared side by side.

<no title>

Deep dive on the Contrast Transfer Function — spatial/temporal coherence envelopes, multi-voltage comparisons, aperture effects, and resolution metrics, with publication-quality figure export.

<no title>

A realistic multislice simulation of hexagonal Si₃N₄ built from an ASE structure via abTEM, validated against a classical multislice reference, including an optional IBM Quantum hardware deployment section.

Quantum STEM

<no title>

Scanning-probe imaging — one quantum circuit per probe position, HAADF / ADF / ABF / BF / iDPC detector channels, and the qubit-vs-field-of-view tradeoff for matching CTEM’s field of view.

Note

Quantum diffraction modes, frozen-phonon/thermal-diffuse-scattering channels, and the Bloch-wave QPE eigensolver are under development on the dev branch and planned for a future release.

Executed Reference Copies

A couple of notebooks are long-running (multislice on a real crystal structure, IBM hardware calls) and are also kept with outputs pre-executed so readers can see results without re-running them: <no title>, <no title>.

Previous Next

© Copyright 2026, Roberto dos Reis and Sean D. Lam.

Built with Sphinx using a theme provided by Read the Docs.