Overview - qBraid

Quantum Algorithms Library.

Python package for building, simulating, and benchmarking hybrid quantum-classical algorithms.

Installation

qbraid-algorithms requires Python 3.11 or greater, and can be installed with pip as follows:

pip install qbraid-algorithms

You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:

git clone https://github.com/qBraid/qbraid-algorithms.git
cd qbraid-algorithms
pip3 install .

You can view the version of qbraid-algorithms you have installed within a Python shell as follows:

import qbraid_algorithms

qbraid_algorithms.__version__

from qbraid_algorithms import bernstein_vazirani
secret_key = '01001'
algo = bernstein_vazirani.load_program(secret_key)
print(algo)

See API Reference for complete functionality of each algorithm module.