qbraid-algorithms 0.0.0

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

qbraid-algorithms

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

Installation

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

pip install qbraid-algorithms

[!WARNING] This project is "pre-alpha", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.

Install from source

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 .

Check version

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

import qbraid_algorithms

qbraid_algorithms.__version__

Community

We are actively looking for new contributors!

• Interested in contributing code, or making a PR? See CONTRIBUTING.md
• For feature requests and bug reports: Submit an issue
• For discussions and/or specific questions about qBraid services, join our discord community
• For questions that are more suited for a forum, post to Stack Exchange with the qbraid tag.
• By participating, you are expected to uphold our code of conduct.

Acknowledgements

This project was conceived in cooperation with the Quantum Open Source Foundation (QOSF).

License

GNU General Public License v3.0