qvass 0.1.0

A quantum circuit simulator in Rust.
Documentation
  • Coverage
  • 100%
    20 out of 20 items documented1 out of 6 items with examples
  • Size
  • Source code size: 131.29 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.32 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 18s Average build duration of successful builds.
  • all releases: 22s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • dmidem

Crates.io Docs.rs Actions MSRV Release License

Qvass is a Rust library for building and running quantum circuit simulations, designed to be fast and simple. To ensure correctness, its results are tested against Qiskit.

Documentation

Example

This example creates a 3-qubit GHZ state ((|000⟩ + |111⟩)/√2), a famous example of quantum entanglement.

use rand::{rngs::SmallRng, SeedableRng};

use qvass::{Gate, QuantumSimulator, QubitError};

fn main() -> Result<(), QubitError> {
    // 1. Create a simulator for a 3-qubit system.
    let mut sim = QuantumSimulator::new(3);

    // 2. Build the circuit to create the GHZ state.
    sim.add_gate(Gate::hadamard(), [0])?;
    sim.add_gate(Gate::cnot(), [0, 1])?;
    sim.add_gate(Gate::cnot(), [0, 2])?;

    // 3. Create a seeded RNG for reproducible measurements.
    // For a real simulation, you might seed this from the system time.
    let mut rng = SmallRng::seed_from_u64(123);

    // 4. Start from the |000⟩ state, run the simulation, and measure.
    sim.init_state(0);
    sim.run();
    let outcome = sim.measure(&mut rng);

    // After measurement, the state will be either |000⟩ (index 0)
    // or |111⟩ (index 7), with a 50/50 chance for each.
    println!("Measured state: |{}>", outcome);
    assert!(outcome == 0 || outcome == 7);

    Ok(())
}

More examples can be found in the examples folder in the root of this repository. To run a specific example, use the command: cargo run --example <example_name>.

Features

  • Build Complex Gates and Circuits: Easily combine simple gates and circuits to create complex ones. This lets you create reusable components, like the included Quantum Fourier Transform (QFT).
  • Fast Simulation: The simulator is optimized for speed, especially for circuits with many controlled gates.
  • Correctness First: All gate operations are tested against Qiskit.
  • no_std Compatible: Usable in environments without the standard library, like embedded systems and WebAssembly.

Project Folders Structure

  • 📁 src: The core Rust library code.
  • 📁 scripts: Python scripts used to test the simulator against Qiskit.
  • 📁 examples: Standalone example programs showing how to use the library.

License

Licensed under either of Apache License, Version 2.0 (LICENSE-APACHE) or MIT license (LICENSE-MIT) at your option.

See Also