Home
-
Docs
Browse the API reference, generated from the package.
-
CLI
Use the command-line interface for the builder UI and research commands.
-
Source
Version 1.0
The documented Python packages, the version 1 run document, shadowsim serve and the research commands, the builder lanes and actions, new-backend and new-simulator, the documented examples, and the named extras stay compatible through the 1.x line. A break to that surface is a new major version. Details are in the changelog.
Background¶
ShadowSim builds shadow Hamiltonians for small qubit systems, following shadow Hamiltonian simulation 1. The open cavity–emitter example is a Tavis–Cummings model 2. The single-emitter factory is Jaynes–Cummings.
Local preview¶
Open the URL printed in the terminal (usually http://127.0.0.1:8000).
The API reference is generated from shadowsim. Optional backends are imported during the build, so the qutip and qiskit extras need to be installed. The qiskit extra also installs SciPy, which the product-formula simulators import. The docs build does not install the qulacs or cirq extras: QulacsCircuitBackend and CirqCircuitBackend import those libraries only when a circuit runs. Tests that run those backends with a product-formula simulator use the circuits marker together with qulacs or cirq and cross_extra.
Customizing this site¶
Edit mkdocs.yml (theme, colors, fonts, nav) and add Markdown files under docs/. The API section is filled in by mkdocs-api-autonav. Push to main to redeploy.
-
R. D. Somma, R. King, R. Kothari, T. O'Brien, and R. Babbush. Shadow Hamiltonian simulation. 2024. URL: https://arxiv.org/abs/2407.21775, arXiv:2407.21775. ↩
-
A. N. Sims, D. Patel, A. Philip, A. H. Rubin, R. Bandyopadhyay, M. Radulaski, and M. M. Wilde. Digital quantum simulations of the non-resonant open Tavis-Cummings model. 2025. URL: https://arxiv.org/abs/2501.18522, arXiv:2501.18522. ↩