Skip to content

CLI Usage

QPyth provides an interactive command-line interface for exploring quantum computing concepts and running simulations.

Starting the CLI

qpy

Or via Python module:

python -m quantumpytho

=== QPyth App ===
1) Sacred-geometry QRNG sequence
2) Circuit explorer (Bell pair)
3) Circuit explorer (Hadamard sweep)
4) TMT Sierpinski fractal (21-qubit)
5) Bloch State Vector Projection (ASCII)
6) Non-local Teleportation Bridge
7) Molecular Ground-State (VQE Sim)
8) Toggle Quantum Decoherence [OFF]
9) Quantum Error Correction
q) Quit

Options

1. Sacred-geometry QRNG Sequence

Generates quantum random numbers scaled by the golden ratio φ = (1+√5)/2 ≈ 1.618.

Features: - Configurable number of qubits (4-12) - Configurable sequence length (8-32) - Sacred geometry scaling

Example: 

Select option: 1
Number of qubits [8]: 8
Sequence length [16]: 16

2. Circuit Explorer (Bell Pair)

Creates and runs a Bell pair circuit to demonstrate quantum entanglement.

Features: - Creates |Φ⁺⟩ = (|00⟩ + |11⟩)/√2 state - Shows measurement counts - Displays circuit diagram

Example: 

Select option: 2

3. Circuit Explorer (Hadamard Sweep)

Applies repeated Hadamard gates to explore quantum superposition.

Features: - Configurable depth (1-10) - Shows measurement distribution - Displays circuit diagram

Example: 

Select option: 3
Depth [1-10]: 5

4. TMT Sierpinski Fractal (21-qubit)

Creates a 21-qubit circuit implementing the TMT Sierpinski fractal pattern.

Features: - 21-qubit circuit - Fractal pattern visualization - Sacred geometry connection

Example: 

Select option: 4

5. Bloch State Vector Projection (ASCII)

Visualizes quantum states on the Bloch sphere using ASCII art.

Features: - Configurable theta (θ) angle [0, π] - Configurable phi (φ) angle [0, 2π] - Shows statevector and measurement probabilities

Example: 

Select option: 5
Theta (θ) [0.0-3.14159]: 1.047
Phi (φ) [0.0-6.28318]: 1.571

Output: 

State Vector Projection (θ=1.047000, φ=1.571000):
Statevector([ 8.66e-01+0.j, -1.02e-04+0.4999j], dims=(2,))
|0> state: [###############-----]   75.01% (768 shots)
|1> state: [#####---------------]   24.99% (256 shots)

6. Non-local Teleportation Bridge

Demonstrates quantum teleportation protocol.

Features: - Standard Nielsen & Chuang protocol - Shows circuit structure - Explains classical communication requirement

Example: 

Select option: 6

7. Molecular Ground-State (VQE Sim)

Runs Variational Quantum Eigensolver for molecular ground states.

Features: - H₂ molecule simulation - Physical energy calculation (with optional dependencies) - Energy convergence visualization

Example: 

Select option: 7

Requirements: - Core: qiskit, qiskit-aer - Physical energies: qiskit-algorithms, qiskit-nature, pyscf

8. Toggle Quantum Decoherence

Enables or disables quantum decoherence in simulations.

Features: - Toggle decoherence on/off - Affects all subsequent simulations - Visual indicator in menu

Example: 

Select option: 8

9. Quantum Error Correction

Accesses QEC submenu with Shor and Steane codes.

Features: - Shor's 9-qubit code - Steane's 7-qubit code - Code comparison - Error injection and correction

Example: 

Select option: 9

QEC Submenu: 

=== Quantum Error Correction ===
1) Shor's 9-qubit Code
2) Steane's 7-qubit Code
3) Compare Codes
4) Back to Main Menu
q) Quit

Keyboard Shortcuts

  • q - Quit the application
  • Ctrl+C - Interrupt current operation

Tips

  1. Start with Bloch Sphere - Option 5 is great for understanding quantum states
  2. Try Bell Pairs - Option 2 demonstrates entanglement clearly
  3. Explore VQE - Option 7 shows practical quantum algorithms
  4. Use QEC - Option 9 teaches error correction concepts
  5. Toggle Decoherence - Option 8 to see noise effects

Advanced Usage

Environment Variables

Configure CLI behavior with environment variables:

# Set default backend
export QPYTH_BACKEND="ibm_brisbane"

# Set default shots
export QPYTH_SHOTS="2048"

# Set execution mode
export QPYTH_MODE="noisy_simulator"

Scripting

You can script CLI interactions:

echo -e "5\n1.047\n1.571\nq" | qpy

Troubleshooting

Import Errors

If you see import errors, ensure QPyth is installed:

pip install QPyth

Missing Dependencies

For VQE with physical energies:

pip install QPyth[physical]

For IBM Quantum hardware:

pip install QPyth[hardware]
export QISKIT_IBM_TOKEN="your-token"

Performance Issues

  • Use fewer shots for faster results
  • Use simulator instead of hardware for testing
  • Reduce circuit depth where possible

Next Steps