How quantumlib/cirq works
Cirq is a Python toolkit for defining, transforming, simulating, and running quantum circuits. The central workflow is to express gates and qubits in a circuit, optionally compile or route it for a device, then simulate it locally or submit it through a provider client and obtain measurement results. The repository also includes noise models, experiments, serialization, and provider-specific integrations. The README documents the main user workflow and capabilities; several provider and subsystem links below are limited to the sampled source and SOURCE INDEX evidence.
Main entry points: circuit.py Circuit Builder · engine.py Google Engine · engine_client.py Engine Client · router.py Circuit Routing
Components 21
Circuit Core
- Gates And Qubits
cirq-core/cirq/ops - Circuit Builder
cirq-core/cirq/circuits/circuit.py - Ancilla Manager
cirq-core/cirq/ops/greedy_qubit_manager.py - JSON Serialization
cirq-core/cirq/protocols/json_serialization.py - Contrib JSON
cirq-core/cirq/contrib/json.py
Compile And Model
- Circuit Transformers
cirq-core/cirq/transformers - Circuit Routing
cirq-core/cirq/contrib/routing/router.py - Device Models
cirq-core/cirq/devices - Noise Models
cirq-core/cirq/devices/noise_model.py
Simulation And Experiments
- Circuit Simulators
cirq-core/cirq/sim - Experiments
cirq-core/cirq/experiments
Google Quantum Engine
- Google Engine
cirq-google/cirq_google/engine/engine.py - Engine Client
cirq-google/cirq_google/engine/engine_client.py - Engine Jobs
cirq-google/cirq_google/engine/engine_job.py - Engine API Types
cirq-google/cirq_google/cloud/quantum_v1alpha1/types/engine.py - Google Program Format
cirq-google/cirq_google/api/v2/program.py
Other Providers
- AQT Sampler
cirq-aqt/cirq_aqt/aqt_sampler.py - IonQ Service
cirq-ionq/cirq_ionq/service.py - Pasqal Device
cirq-pasqal/cirq_pasqal/pasqal_device.py
Other components
- Quantum Developer
- Google Quantum Engine
Connections 22
- Quantum Developer → Circuit Builder: builds
- Circuit Builder → Gates And Qubits: uses
- Quantum Developer → Circuit Simulators: runs locally
- Circuit Builder → Circuit Simulators: simulates
- Quantum Developer → Circuit Transformers: compiles
- Circuit Builder → Circuit Routing: routes
- Circuit Routing → Device Models: targets
- Circuit Builder → Noise Models: models noise
- Quantum Developer → Experiments: analyzes
- Circuit Builder → JSON Serialization: serializes
- Contrib JSON → JSON Serialization: registers resolvers
cirq-core/cirq/contrib/json.py - Ancilla Manager → Gates And Qubits: allocates qubits
cirq-core/cirq/ops/greedy_qubit_manager.py - Quantum Developer → Google Engine: submits circuit
- Google Engine → Engine Client: calls
cirq-google/cirq_google/engine/engine.py - Google Engine → Engine Jobs: creates jobs
cirq-google/cirq_google/engine/engine.py - Engine Jobs → Engine Client: requests results
cirq-google/cirq_google/engine/engine_job.py - Engine Client → Engine API Types: uses requests
- Engine Client → Google Quantum Engine: sends requests
- Google Engine → Google Program Format: uses format
cirq-google/cirq_google/engine/engine.py - Quantum Developer → AQT Sampler: submits runs
- Quantum Developer → IonQ Service: submits runs
- Quantum Developer → Pasqal Device: targets hardware