grovers-visualizer/README.md

1.3 KiB
Raw Blame History

Grovers Search Visualizer

A tiny Python package that steps through Grovers Search algorithm and shows you, after each iteration:

  • A barchart of amplitudes (or probabilities)
  • A sinecurve of successprobability vs. iteration
  • A geometric "rotation" on the unit circle

Demo of Grover’s Visualizer


Installation

Using uv/uvx

uvx grovers-visualizer 1111

Using pip/pipx

pip grovers-visualizer
# or
pipx grovers-visualizer # (recommended)

# and then run
grovers-visualizer

Usage

Flags

  • TARGET
    Target bitstring (e.g. 010). Length also determines number of qubits.
  • -i, --iterations ITERATIONS
    Max iterations; 0 means use the optimal \lfloor\frac\pi4\sqrt{2^n}\rfloor.
  • -s, --speed SPEED
    Delay between iterations (seconds). Default 0.5.
  • -p, --phase PHASE
    The phase \psi (in radians) used for both the oracle and diffusion steps. Defaults to \pi (i.e. a sign-flip, e^{i\pi}=-1).

License

This project is licensed under the MIT License - see the LICENSE file for details.