Wiki Directory

Wiki Directory

This page defines the documentation structure for the FlagQuantum Wiki.

Status: All 21 guides listed below are published. Home provides the learning overview, and the sidebar links to every guide.

Version baseline: FlagQuantum 0.3.1, commit 5714b569cfc94e212b6d175eb7c87e1f36d8cf9d. Each guide records its own validation scope. The October 20, 2026 audit records the original 19-guide audit; later guides record their additional validation on their own pages. Resource links to main below are current development references; use each guide's tagged sources for release behavior.

Start Here

Page	Scope
Quick Start — Published	Install FlagQuantum, run Bell-state and training examples, and interpret the expected outputs.
Installation and Compatibility — Published	Python, PyTorch, operating systems, package versions, and accelerator environment requirements.

Current resource: README installation and training guide.

Fundamentals

Page	Scope
Core Concepts — Published	Circuits, parameters, observables, results, and differentiation.
Qubit Ordering and Result Conventions — Published	Statevector indices, measurement bitstrings, and framework boundary conversions.
From Papers and Equations to FlagQuantum Code — Published	Derive equations, map them to circuits and tensors, and validate values, gradients, and training against independent references.

Current resources: Repository documentation and README qubit ordering.

Tutorials

Page	Scope
Building and Simulating Circuits — Published	Construct circuits and inspect execution outputs.
Training Parameterized Circuits — Published	Define an objective and optimize circuit parameters with PyTorch.
Hybrid Classical-Quantum Models — Published	Combine classical layers and quantum circuits.
Reproducing Molecular Hydrogen VQE — Published	O'Malley 2016: corrected source data, UCC derivation, 54-geometry scan, independent checks, training, and shot-based energy estimation.

Current resource: Runnable examples.

Execution

Page	Scope
Choosing a Simulation Method — Published	Statevector, MPS, and tensor-network methods, resource needs, and limitations.
Accelerator Setup — Published	Supported accelerator paths and environment-specific setup.
Distributed Simulation and Training — Published	Supported distributed workflows, launch requirements, and validation boundaries.

Current resources: Capability catalog and repository documentation.

Advanced Topics

Page	Scope
Circuit Compilation and Interoperability — Published	Circuit transformations, target constraints, and supported framework adapters.
Noise and Open-System Simulation — Published	Supported noise models, noisy execution methods, and Lindblad evolution.
Quantum Error Correction Experiments — Published	Supported local memory experiments, syndrome extraction, decoding, and correction.
Cloud and Quantum Hardware Execution — Published	Provider configuration, execution workflows, credentials, and provider-specific limits.
QPU Digital Twins — Published	Calibration-conditioned predictions, measurement comparison, and evidence scope.

Current resources: Capability catalog, QEC documentation, and repository documentation.

Support and Contribution

Page	Scope
Troubleshooting and FAQ — Published	Common installation and runtime problems, diagnostic steps, and fixes.
Reproducibility and Benchmarks — Published	Reproduce experiments and interpret correctness, capacity, and performance evidence.
Development and Contribution Guide — Published	Development setup, project structure, extension guidance, and contribution workflow.
Documentation Guide — Published	Page templates, version labels, source links, and documentation maintenance.

Current resources: Issues, Contribution guide, and Architecture.

Recommended Reading Order

1. Installation and Compatibility, then Quick Start.
2. Core Concepts, then Qubit Ordering and Result Conventions.
3. Read From Papers and Equations to FlagQuantum Code for the equation-to-implementation workflow, then Building and Simulating Circuits, Training Parameterized Circuits, and Hybrid Classical-Quantum Models.
4. Follow Reproducing Molecular Hydrogen VQE for a complete paper-to-code case study. Select an execution guide and advanced topic for your workload; check their requirements and limits first.
5. Use Troubleshooting and FAQ when blocked, and Reproducibility and Benchmarks before reporting results.
6. Read Development and Contribution Guide and Documentation Guide before contributing code or documentation.

Page Template

Each practical guide should state:

• Goal: What the reader will accomplish.
• Applicable version: Package release or repository commit.
• Requirements: Dependencies, hardware, and provider access, if applicable.
• Steps: Complete instructions and runnable code.
• Expected result: Output and how to interpret it.
• Limitations: Supported scope and known restrictions.
• Troubleshooting: Common failures and recovery steps.
• Sources: Links to maintained repository documentation and executable examples.

Keep version-sensitive API reference and executable examples in the repository. Link to those sources from the Wiki to reduce duplicated maintenance. Mark experimental capabilities explicitly and link to their entry in the capability catalog.

For copyable templates, validation commands, and the maintenance workflow, see Documentation Guide.