Repository navigation
Documentation Guide
Create documentation that a reader can follow, verify, and maintain against a specific FlagQuantum version. This guide covers the Wiki, versioned repository documentation, reusable templates, and checks before publication.
Reference: FlagQuantum v0.3.1, commit 5714b569cfc94e212b6d175eb7c87e1f36d8cf9d; reviewed October 20, 2026. Commands and source paths below refer to that release unless stated otherwise. For a contribution to current main, follow the policies and tool versions in that checkout. The templates and Wiki helper below are documentation examples, not additional FlagQuantum APIs or an existing Wiki CI service.
Validation: The CPU Bell example was executed with Python 3.12.14, PyTorch 2.13.0, and FlagQuantum 0.3.1 on macOS ARM64. The three-file repository link/language checks and the Wiki helper were executed. The generated-document check stopped at history validation because the reference checkout is shallow; it is not recorded as passing. Regeneration and the full repository/CI checks were not executed.
The Wiki is the learning and navigation layer. Keep API contracts, support policies, executable examples, and documentation that must change with code in the main repository. Link to those sources rather than maintaining a second independent specification.
| Location | Content and maintenance rule |
|---|---|
Wiki Home, Wiki Directory, _Sidebar
|
Entry points, learning paths, and links to published pages. Update all three when adding a guide. |
| Wiki tutorials | Complete workflows, explanations, expected results, and troubleshooting. State the version and actual validation scope. |
Root README.md
|
Product purpose, a complete small example, and starting links. |
Module README.md
|
Ownership, design intent, shortest usage/change path, and focused verification. Split a longer guide only when needed. |
docs/concepts/ |
Product-wide principles and conceptual explanations. |
docs/architecture/ |
Runtime and subsystem design, architecture decisions. |
docs/reference/ |
Public APIs, contracts, support policies, limitations, release notes. |
docs/guides/ |
Operational runbooks and detailed usage/performance workflows. |
docs/development/ |
Engineering, testing, dependencies, contribution, and release policies. |
docs/api-changes/ |
Proposed or approved changes to protected interfaces. A proposal is not proof of implementation. |
docs/roadmap/ |
Future intent, maturity, and plans; label unfinished behavior explicitly. |
docs/generated/ and marked generated regions |
Derived inventories. Edit the authorized source and run the generator; preserve generated markers. |
examples/, tests/, benchmarks/
|
Runnable examples, behavioral regression tests, and benchmark methodology/evidence. |
Start with the repository documentation index, development index, and source-of-truth map. The map identifies authorities such as docs/public_api_v1.json, docs/operator_manifest.json, capability-maturity.toml, and pyproject.toml.
A successful simulator example does not establish accelerator, distributed, cloud, or hardware support. Link capability claims to the relevant capability catalog, including its maturity and workload limits.
Place a short metadata table near the top of a practical guide. Use a release tag and, when reproducibility matters, the full commit. Record dependencies and hardware for commands that were actually executed.
| Label | Meaning |
|---|---|
Executed |
The complete example ran in the recorded environment; assertions and results were inspected. |
Syntax checked only |
Parsing or compilation succeeded; dependencies, runtime behavior, and results remain unverified. |
Dry run only |
A plan or submission preview was inspected; the actual workload was not executed. |
Requires external access; not executed |
Credentials, a provider account, hardware, or a paid service are required and were not exercised. |
Design sketch; non-executable |
Future or illustrative API proposal. Never present it as a runnable command. |
These are recommended editorial labels for this Wiki, not a new repository contract. Add the checked date, platform, backend, device, precision, and seed where relevant. A page edit date alone is not a test date. Preserve old validation records when adding a newer version's result.
Use pinned source links such as .../blob/v0.3.1/docs/reference/API.md for release-specific instructions; immutable commit links are stronger evidence. Use .../blob/main/... for current development guidance and say that it may differ from the installed release. For multiple versions, provide separate sections with their tested environments or an explicit compatibility table. Do not silently relabel an old example as tested on a new release.
Separate deterministic output from stochastic samples, tolerances, timings, and machine-dependent paths. Training examples should check meaningful convergence/gradient behavior with suitable tolerances rather than require identical floating-point text on every platform.
Copy the following Markdown into a new Wiki page and replace every {{...}} field. Remove irrelevant sections rather than filling them with unsupported claims. Use a descriptive title, such as Documentation Guide, which GitHub maps to Documentation-Guide in the page URL.
# {{PAGE_TITLE}}
{{One sentence describing the reader's concrete goal.}}
| Item | Value |
| --- | --- |
| Applicable release / commit | {{RELEASE_AND_COMMIT}} |
| Checked date | {{YYYY_MM_DD}} |
| Validation | {{EXECUTED_OR_OTHER_EXPLICIT_STATUS}} |
| Environment | {{PYTHON_TORCH_OS_BACKEND_DEVICE_PRECISION}} |
## Requirements
{{Dependencies with versions, installation link, and any hardware/account requirements.}}
## Steps
Save the complete script below as `{{SCRIPT_NAME}}.py`.
```python
# Replace this placeholder with a complete, executable example.
```
Run from {{WORKING_DIRECTORY}} in the configured environment:
```bash
python {{SCRIPT_NAME}}.py
```
## Expected Result
```text
{{REAL_OUTPUT_OR_CLEARLY_IDENTIFIED_OUTPUT_PATTERN}}
```
{{Explain the result, assertions, tolerances, and any stochastic variation.}}
## Limits and Troubleshooting
{{State unsupported paths and common errors with actionable recovery steps.}}
## Sources and Related Pages
- [Versioned source]({{PINNED_SOURCE_URL}})
- [Related guide]({{WIKI_PAGE_URL}})
## Verification Record
{{Exact commands, outcomes, environment, and checks not performed.}}For reference pages, replace the step-by-step workflow with a contract/table and small examples. For design documents, put Future intent near the top and define behavioral acceptance criteria. Use English for repository prose, comments, outputs, and Wiki content; follow the repository's narrowly documented localization exception where applicable.
In an environment configured using Installation and Compatibility, save this as example_bell.py. It deliberately selects the local CPU PyTorch statevector path and performs no cloud submission.
import torch
import flagquantum as fq
circuit = fq.Circuit(2).h(0).cx(0, 1)
options = fq.ExecutionOptions(
mode="statevector", backend="pytorch", device="cpu"
)
result = fq.run(circuit, outputs=fq.probabilities(), options=options)
probabilities = result.probabilities
expected = torch.tensor(
[[0.5, 0.0, 0.0, 0.5]], dtype=probabilities.dtype,
device=probabilities.device,
)
assert probabilities.shape == (1, 4)
assert torch.allclose(probabilities, expected, atol=1e-6, rtol=0)
print("probabilities:", [round(x, 6) for x in probabilities[0].tolist()])
print("Bell-state check passed.")Run these commands from the directory containing the file:
python -m py_compile example_bell.py
python example_bell.pyExpected output from execution:
probabilities: [0.5, 0.0, 0.0, 0.5]
Bell-state check passed.
Successful py_compile normally prints nothing. It only checks syntax; the second command executes the example and its assertions. The probability batch has shape (1, 4) and corresponds to 00, 01, 10, 11, with qubit 0 as the most-significant bit. See Qubit Ordering and Result Conventions.
For a maintained repository example, keep the executable file in the appropriate examples/ area and link to it from the Wiki. If a copy appears inline, run the copy as published, including its imports and setup. Use regression tests when behavior needs ongoing protection; a documentation-only formatting edit does not need a new test that mirrors the text.
Run repository tools from the FlagQuantum source checkout, with the development environment activated as described in Development and Contribution Guide. Installing the runtime wheel alone does not install this checkout's tools/ directory.
A small, reproducible documentation check:
python tools/check_docs_links.py docs/README.md docs/development/README.md docs/development/REPOSITORY_GOVERNANCE.md
python tools/check_repository_language.py docs/README.md docs/development/README.md docs/development/REPOSITORY_GOVERNANCE.md
python tools/docs_source_of_truth.py --check
git diff --checkObserved output for the first two commands at the pinned release:
Checked 3 markdown files; all local links and anchors resolve.
Checked 3 paths; 0 files violate the language policy.
Binary images and non-UTF-8 files require separate visual review.
The source-of-truth check normally exits zero without a success message when valid; third-party imports can emit environment messages. git diff --check is also silent when no whitespace errors are found. Never infer success from silence without checking the exit code.
For broader repository checks, omit the positional paths:
python tools/check_docs_links.py
python tools/check_repository_language.pyThe link checker validates local Markdown file targets and heading anchors; it does not probe external HTTP links. The language checker detects prohibited Han-script content within its policy scope and explicitly requires separate image review; it is not a complete English style checker. The two full-repository scans above were not used as evidence for this page's scoped three-file results.
The source-of-truth check also validates capability evidence revisions. In the shallow v0.3.1 reference checkout used for this page, it exited 1 with an invalid capability maturity matrix error: three multi-node evidence code_version entries could not be checked because the clone lacked history. This does not establish that those revisions are invalid, and it is not a passing check.
Use a full-history clone for this validation. For an existing shallow clone, inspect its state and fetch the missing history from its configured origin before retrying:
git rev-parse --is-shallow-repository
# Run the next command only when the preceding output is true.
git fetch --unshallow origin
python tools/docs_source_of_truth.py --checkFetching full history can transfer substantial data; the recovery fetch and subsequent check were not executed for this page. A clone made without --depth is the usual starting point for contribution/provenance workflows. Never suppress a provenance failure by deleting evidence or weakening the manifest.
python tools/docs_source_of_truth.py
git diff -- README.md docs/generated docs/reference/KNOWN_LIMITATIONS.md docs/reference/CUDAQ_PARITY_MATRIX.md
python tools/docs_source_of_truth.py --checkWithout --check, the generator writes its managed files/regions and then validates them. Review every resulting change. Do not edit generated output to hide a stale manifest, change protected exports/schemas just to make a check pass, or promote a capability's maturity without the required evidence and approval. Follow Public API Protection and the checkout's policies.
The read-only --check path was attempted with the shallow-history limitation recorded above; regeneration is a maintenance command supplied for authorized source changes and was not performed. This check is not a substitute for the independent benchmark/evidence audits identified in docs/source_of_truth.json or for the repository's required contribution gates.
GitHub Wiki content has its own Git repository and commit history. Repository documentation checks do not automatically validate or publish it. Obtain a separate checkout, using another directory if this name already exists:
git clone https://github.com/flagos-ai/FlagQuantum.wiki.git FlagQuantum-wiki
cd FlagQuantum-wiki
git status --shortThe following focused helper is ready to run from the Wiki checkout using Python 3.10 or newer. It checks that a selected page exists, has a matching top heading, and is linked from all three navigation files. It is a local editorial check, not a complete Markdown parser, external-link validator, or installed project command.
Save as check_wiki_page.py outside the tracked Wiki content, or use it temporarily and exclude it from the commit:
import re
import sys
from pathlib import Path
from urllib.parse import unquote, urlsplit
root = Path.cwd()
slug = sys.argv[1] if len(sys.argv) > 1 else "Documentation-Guide"
page = root / f"{slug}.md"
assert page.is_file(), f"Missing page: {page.name}"
text = page.read_text(encoding="utf-8")
assert text.splitlines()[0] == "# " + slug.replace("-", " "), "Title mismatch"
base = "/flagos-ai/FlagQuantum/wiki/"
for filename in ("Home.md", "Wiki-Directory.md", "_Sidebar.md"):
navigation = (root / filename).read_text(encoding="utf-8")
targets = re.findall(r"(?<!!)\[[^\]]+\]\(([^)\s]+)\)", navigation)
linked = False
for target in targets:
parsed = urlsplit(target)
path = unquote(parsed.path)
absolute = (
parsed.netloc.lower() == "github.com" and path == base + slug
)
relative = not parsed.scheme and path in (slug, slug + ".md")
linked = linked or absolute or relative
assert linked, f"{filename} does not link to {slug}"
print(f"Wiki navigation check passed: {slug} (3 entry points).")Run it with assertions enabled (do not use Python's -O option):
python check_wiki_page.py Documentation-Guide
git diff --check
git diff -- Documentation-Guide.md Home.md Wiki-Directory.md _Sidebar.mdExpected helper output:
Wiki navigation check passed: Documentation-Guide (3 entry points).
The simple title convention fits this page; adapt it for titles containing punctuation. The helper reads ordinary inline Markdown links in navigation files and ignores heading fragments when comparing page paths. Review headings, code fences, tables, relative links, and images in GitHub's rendered page as a separate step. Open important external links manually or with an appropriate HTTP checker; a link requiring authentication cannot be certified by an anonymous status check.
For a new, untracked page, git diff will not display its body. Read it directly or stage only the intended files before reviewing the staged diff:
git add Documentation-Guide.md Home.md Wiki-Directory.md _Sidebar.md
git diff --cached --check
git diff --cached -- Documentation-Guide.md Home.md Wiki-Directory.md _Sidebar.mdThese commands stage changes; they do not publish them. Commit only the intended Markdown files. With Wiki write access and after review, publication uses the Wiki checkout's normal Git workflow:
git commit -m "docs: add Documentation Guide"
git push origin HEADDo not assume the main repository's branch name or PR/CI rules apply to the Wiki. A source repository PR does not publish Wiki changes. Use the team's review arrangement for Wiki edits and verify the rendered page and navigation after pushing. Editing through GitHub's Wiki editor also creates a Wiki revision; check for concurrent edits before publishing.
-
Identify the trigger and owner. API/default changes, support-policy updates, releases, broken links, and user reports can all require a documentation change. Read
CONTRIBUTING.md, applicableAGENTS.mdinstructions, and the owning module's README for source contributions. - Update the authority first. Change the approved source, runnable example, or reference in the same code contribution where possible. Keep a Wiki follow-up explicitly tracked when its separate repository prevents one atomic change.
-
Update affected guides and navigation. Search for the old API name, version, title, or URL with
rg -n. Check installation, concepts, relevant tutorials, limitations, and FAQ entries. Preserve existing URLs when possible; if a page must move, update inbound links and leave a useful migration pointer where appropriate. - Validate the actual workflow. Start from documented prerequisites in a clean environment, execute copied examples, inspect assertions/results, run applicable documentation checks, and record unsupported or untested paths honestly. Keep credentials and machine-specific secrets out of content and logs.
- Review and publish. Review the complete diff, rendered Markdown, claim scope, source links, version labels, and changed navigation. Follow source-repository review/CI requirements for repository changes, and the Wiki review process for Wiki revisions.
- Verify and revisit. Open the published page and its three entry points. At a release or relevant behavior change, re-run affected examples, retain the old version's validation history, and record the new result. Use Wiki Git history to inspect or recover previous content.
Keep durable, compact reproduction instructions and evidence summaries. Large traces, checkpoints, repeated result matrices, and superseded outputs belong in the approved evidence/archive workflow described by Repository Governance, with provenance and reproduction references. Avoid turning the Wiki into an unversioned dump of raw experimental data.
Use this in a source PR, a Wiki review note, or a documentation issue. It records evidence without claiming that an unrun gate passed.
### Documentation change
- Trigger / reader impact: {{WHAT_CHANGED_AND_WHY}}
- Owner / related issue or source PR: {{LINK}}
- Pages and navigation affected: {{FILES_AND_URLS}}
- Source of truth: {{RELEASE_OR_COMMIT_AND_PINNED_LINKS}}
- Environment: {{PYTHON_TORCH_OS_DEVICE_AND_OPTIONAL_DEPENDENCIES}}
- Commands actually executed: {{EXACT_COMMANDS}}
- Outcomes: {{EXIT_CODES_ASSERTIONS_AND_OBSERVED_RESULTS}}
- Not executed / limitations: {{HARDWARE_CLOUD_FULL_CI_OR_OTHER_GAPS}}
- Generated changes: {{NONE_OR_AUTHORIZED_INPUTS_AND_REVIEWED_OUTPUTS}}
- Rendered page and links checked: {{URLS_AND_RESULT}}
- Follow-up / version migration: {{ISSUE_OR_NONE_WITH_REASON}}Before publishing, confirm that placeholders are filled, each claimed executable example is complete, validation labels match the evidence, version-sensitive claims have sources, navigation points to real pages, and no generated/API contract changes were smuggled into a prose edit. A formatting check alone cannot establish technical correctness.
For a guide that explains mathematics, place a compact equation/code comparison immediately after each derivation, before the complete runnable script. Use one row per mathematical operation. The comparison should identify symbols, parameter indices, tensor shapes, conventions, and an independent numerical check. Label excerpts as excerpts; keep complete imports, setup, and execution commands in the runnable files.
| Documentation element | Required correspondence |
|---|---|
| State or unitary | Initial state, wire order, angle convention, and gate execution order |
| Probability or observable | Requested output, result accessor, and batch/measurement dimensions |
| Objective | Coefficients, target definition, normalization, and scalar reduction |
| Derivative | Parameter ownership and a small analytical, matrix, or finite-difference reference |
| Optimizer update | Actual optimizer and settings; do not label Adam as plain gradient descent |
| Numerical evidence | Assertions, tolerances, expected output, and the tested environment |
Use a fenced math block for display equations and GitHub's dollar/backtick form for inline equations. A code span inside the dollar delimiters protects backslashes from Markdown escaping. Keep literal vertical bars out of Markdown table cells; use LaTeX commands such as \lvert and \rvert inside protected inline math instead.
Keep equation numbers as ordinary text above a math block. Do not use \tag, which can produce unsupported labeled MathML rows in some browsers. Prefer supported commands such as \mathrm or \arctan; verify the rendered result rather than assuming that any valid TeX command is accepted. These examples are source templates, not additional runnable Python files:
**Equation (1).**
```math
E(\theta)=\cos\theta,\qquad \frac{dE}{d\theta}=-\sin\theta.
```
| Equation | Code excerpt from the complete script | Independent check |
| --- | --- | --- |
| $`E(\theta)=\cos\theta`$ | `energy = result.expectation().mean()` | Compare energy with theta.cos(). |
| $`dE/d\theta=-\sin\theta`$ | `energy.backward()` | Compare theta.grad with -theta.detach().sin(). |Validate both layers: execute code copied from the page, then open the published page in a browser. Check every math renderer for parse errors and inspect matrices, aligned derivations, inline table formulas, and line wrapping visually. The existence of a math-renderer HTML tag alone does not prove that its formula rendered. For noisy or sampled examples, state statistical tolerances; for unavailable hardware/provider paths, report syntax or help checks without calling them execution evidence.
This follow-up covers 15 existing guides, in addition to the separately verified From Papers and Equations to FlagQuantum Code. It preserves the historical audit below and the original page environments. The release baseline remains FlagQuantum 0.3.1, reference commit 5714b569cfc94e212b6d175eb7c87e1f36d8cf9d.
The reviewed guides are Core Concepts, Qubit Ordering and Result Conventions, Building and Simulating Circuits, Training Parameterized Circuits, Hybrid Classical-Quantum Models, Choosing a Simulation Method, Accelerator Setup, Distributed Simulation and Training, Circuit Compilation and Interoperability, Noise and Open-System Simulation, Quantum Error Correction Experiments, QPU Digital Twins, Quick Start, Reproducibility and Benchmarks, and Troubleshooting and FAQ.
| Check | Result and scope |
|---|---|
| Formula/code pairing | Displayed derivations and mathematical relationships previously written in prose now have adjacent equation/code tables. Forward values, gradients, losses, bit ordering, noise, decoding, timing, and optimizer semantics are distinguished. |
| Local runnable code | 52 Python script/module blocks executed successfully using files extracted from these pages, including the synthetic calibration, QEC/Stim, Qiskit conversion, hybrid training, and benchmark examples. Shared helper files were saved first. |
| Distributed examples | Two additional scripts passed with two local CPU/Gloo workers. The sharded training example matched its analytical loss history and updated parameters; each rank wrote its report. This is a single-host correctness check, not a multi-host or accelerator scaling measurement. |
| Account-dependent/context code | The live Quafu script passed syntax and --help checks only. Two continuation snippets passed syntax checks only. No provider calls or QPU tasks were submitted. |
| Independent checks | Existing analytical assertions passed. Additional checks independently applied amplitude-damping Kraus operators and their completeness identity, and recomputed twin-versus-fixture total variation distance from distributions. |
| Expected outputs | Local deterministic stdout matched the earlier recorded audit results; differences were limited to benchmark timings and their variability statistics. Assertions remained the correctness criteria. |
| Markdown and links | Fences and Python syntax were checked; 55 Bash blocks across these guides and this maintenance page were syntax-checked without executing installation or account-dependent commands. Wiki links, anchors, pinned source paths, and navigation coverage were checked. |
| Browser rendering | All 117 formula elements across the 15 guides rendered successfully, with no parse errors. Matrices, aligned formulas, and equation/code tables were visually inspected. |
The execution environment was Python 3.12.14, PyTorch 2.13.0, NumPy 2.5.4, Qiskit 2.5.0, Stim 1.16.0, macOS ARM64, with CPU execution. Save each page's complete Python blocks under their documented filenames and run the displayed python filename.py commands in page order. Use python twin_quafu_live.py --help for its account-free interface check. For the distributed examples, the exact local launch pattern is:
python -m torch.distributed.run --nnodes=1 --nproc-per-node=2 --master-addr=127.0.0.1 --master-port=29531 dist_preflight.py --device cpu
python -m torch.distributed.run --nnodes=1 --nproc-per-node=2 --master-addr=127.0.0.1 --master-port=29532 dist_train.py --device cpu --report-dir distributed-reports-formula-auditThe two files must be copied from Distributed Simulation and Training into the same working folder first. CUDA/FlagOS hardware execution, Windows commands, multi-host execution, installation in a fresh environment, live calibration retrieval, and provider/hardware submission were not executed. Nothing in this review upgrades the capability scope or maturity of those paths.
This review covered 21 Wiki pages plus _Sidebar.md: Home, Wiki Directory, and 19 guides. The audited source baseline is FlagQuantum 0.3.1, commit 5714b569cfc94e212b6d175eb7c87e1f36d8cf9d.
| Check | Result and scope |
|---|---|
| Links and navigation | All 22 Markdown files were scanned outside fenced examples. Wiki page targets, heading anchors, and pinned source paths resolved; every guide was linked from Home, Wiki Directory, and the sidebar. Remaining external/development link destinations returned HTTP 200 during the check; redirects were inspected where applicable. |
| Markdown and syntax | Code fences were balanced. All 67 Python blocks compiled, and 96 Bash blocks passed bash -n without executing their installation, publishing, or account-dependent commands. Three PowerShell blocks were reviewed but were not run on Windows. |
| Local examples | 61 Python blocks executed successfully: 58 ordinary local script/module/helper blocks, one regression test through pytest, and two examples launched with two local CPU/Gloo processes. Shared helper files were saved under the documented names before dependent scripts ran. |
| Output comparison | Deterministic outputs matched the displayed results. Expected differences were limited to runtime versions, interpreter paths, and benchmark timings/stability measurements. Random counts and statistical results remain environment-dependent as described in their guides. |
| Account-dependent examples | Three complete cloud/hardware scripts passed syntax and --help checks. Three continuation/context snippets passed syntax checks only. No live provider authentication, calibration download, remote job, or QPU submission was performed in this audit. |
| Version labels | All 19 guides explicitly target 0.3.1. Quick Start's technical follow-up links were pinned to the same release; Home and Wiki Directory now state the shared version baseline and distinguish current-development resources. |
The execution environment was Python 3.12.14, PyTorch 2.13.0, NumPy 2.5.4, Qiskit 2.5.0, Stim 1.16.0, macOS ARM64, using local CPU execution. The regression test used the source-development environment with pytest 9.1.1 and the repository's marker configuration. Earlier page records mentioning PyTorch 2.14.1 are preserved; this audit adds evidence for the 2.13.0 environment rather than overwriting historical measurements.
Corrections removed stale references to planned guides, replaced the completed writing plan with a reading path, clarified release versus main links, and added this scoped verification record. No numerical example required a logic change. Installation commands, wheel downloads/installations on other platforms, CUDA/FlagOS hardware execution, multi-host scaling, provider SDK submission, and the complete source CI/pre-push gate were not re-executed. The shallow-clone provenance limitation documented above remains unresolved by this Wiki audit; it must not be described as a passing generated-document check.
Link reachability and successful small examples do not establish every support or performance claim. Re-run affected checks when code, dependencies, provider contracts, or page URLs change.
- Repository documentation index — v0.3.1
- Development documentation and README writing guidance — v0.3.1
- Documentation source-of-truth tool — v0.3.1
- Local link checker — v0.3.1
- Repository language checker — v0.3.1
- Contribution requirements — v0.3.1
- Development and Contribution Guide
- Reproducibility and Benchmarks
- Wiki Directory
- Installation and Compatibility
- Quick Start
- Install and Run
- Qubit Ordering and Result Conventions
- Runnable Examples
- Building and Simulating Circuits
- Training Parameterized Circuits
- Hybrid Classical-Quantum Models
- Core Concepts
- From Papers and Equations to FlagQuantum Code
- Reproducing Molecular Hydrogen VQE
- Fundamentals
- Tutorials
- Choosing a Simulation Method
- Accelerator Setup
- Distributed Simulation and Training
- Execution
- Circuit Compilation and Interoperability
- Noise and Open-System Simulation
- Quantum Error Correction Experiments
- Cloud and Quantum Hardware Execution
- QPU Digital Twins
- Advanced Topics
- Support and Contribution
All 21 guides are linked in the navigation sections. The Wiki Directory lists published guides and current repository resources.
- Troubleshooting and FAQ
- Reproducibility and Benchmarks
- Development and Contribution Guide
- Documentation Guide
Documentation, capability, and contribution links in this section follow current main; the guides above target 0.3.1.