​
CLI Usage

qBraid Algorithms includes a command-line interface (CLI) for generating quantum algorithm subroutines. These subroutines can either be saved in .qasm files or displayed directly in the terminal, providing users with a convenient way to access and utilize quantum algorithms.

​
Installation

To use the CLI, install with CLI dependencies: 
pip install "qbraid-algorithms[cli]"
Or install from source: 
pip install -e ".[cli]"

​
Generate Subroutines

Generate quantum algorithm subroutines that can be included in other circuits:
  • Generate QFT subroutine for 4 qubits
qbraid-algorithms generate qft --qubits 4 --show
  • Generate IQFT subroutine for 3 qubits with custom name and show the circuit
qbraid-algorithms generate iqft -q 3 -o my_iqft.qasm --gate-name my_iqft --show
  • Generate only the oracle for Bernstein-Vazirani
qbraid-algorithms generate bernvaz -s "1001" --oracle-only --show
  • Generate a QPE subroutine for phase estimation:
qbraid-algorithms generate qpe --unitary-file gate.qasm --qubits 3 --show

​
Help

Get help for any command: 
qbraid-algorithms --help
qbraid-algorithms generate --help
qbraid-algorithms generate qft --help
qbraid-algorithms generate iqft --help
qbraid-algorithms generate bernvaz --help

​
Examples

​
Complete Workflow

  1. Generate a QFT subroutine: 
    qbraid-algorithms generate qft --qubits 3
  2. Generate a Bernstein-Vazirani oracle and view it: 
    qbraid-algorithms generate bernvaz --secret "101" --oracle-only --show
  3. Generate an IQFT circuit with custom output: 
    qbraid-algorithms generate iqft --qubits 4 --output my_iqft_4.qasm --show