User Guide

User Guide#

This guide covers how to use FlagQuantum for quantum circuit simulation and training: building programs, planning and running them, training with PyTorch, choosing a simulation representation, adding noise and measurement, scaling across ranks, and moving the same program to hardware.

Basic Usage

Build a circuit, plan it, run it and read the result.

Basic usage
Circuits and IR

Circuit construction, FlagQuantum IR, compilation and routing.

Circuits and FlagQuantum IR
Training with PyTorch

Trainable circuits, optimizers, named parameters and checkpoints.

Training with PyTorch
Measurement and Noise

Observables, result accessors, noise models and dynamic circuits.

Measurement and noise
Simulation Representations

Statevector, MPS, tensor network and JAX kernels.

Simulation representations
Distributed Execution

Sharded statevector and rank-owned MPS training.

Distributed execution
Hardware and Remote Targets

FlagOS accelerators, remote jobs, deployment packages.

Hardware and remote targets
Algorithms and QEC

Algorithm units, error-correction experiments and digital twins.

Algorithms, error correction and digital twins
Tutorials

The tutorial series and the example catalog.

Tutorials
Run Tests

Test tiers and marker commands.

Run tests