Metadata-Version: 2.1
Name: qbraid-algorithms
Version: 0.0.0
Summary: Python package for building, simulating, and benchmarking hybrid quantum-classical algorithms.
Author: qBraid Development Team
Author-email: contact@qbraid.com
License: GNU General Public License v3.0
Project-URL: Homepage, https://github.com/qBraid/qbraid-algorithms
Project-URL: Documentation, https://docs.qbraid.com
Project-URL: Bug Tracker, https://github.com/qBraid/qbraid-algorithms/issues
Project-URL: Discord, https://discord.gg/TPBU2sa8Et
Project-URL: Launch on Lab, https://account.qbraid.com/?gitHubUrl=https://github.com/qBraid/qbraid-algorithms.git
Keywords: qbraid,quantum,algorithms,qml
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch <3.0,>=2.3
Requires-Dist: numpy <2.2,>=1.17
Requires-Dist: scipy <1.15.0,>=1.13.1
Requires-Dist: bloqade <0.16,>=0.15.12
Requires-Dist: scikit-learn <1.6.0,>=1.5.0
Provides-Extra: docs
Requires-Dist: sphinx <8.2,>=7.4 ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints <2.6,>=1.24 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme <3.0.2,>=2.0.0 ; extra == 'docs'
Requires-Dist: docutils <0.22 ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Provides-Extra: lint
Requires-Dist: isort ; extra == 'lint'
Requires-Dist: ruff ; extra == 'lint'
Requires-Dist: qbraid-cli ; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Provides-Extra: visualization
Requires-Dist: matplotlib ; extra == 'visualization'

# qbraid-algorithms

<p align="left">
  <a href="https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml">
    <img src="https://github.com/qBraid/qbraid-algorithms/actions/workflows/main.yml/badge.svg?branch=main" alt="CI"/>
  </a>
  <a href="https://codecov.io/gh/qBraid/qbraid-algorithms"> 
    <img src="https://codecov.io/gh/qBraid/qbraid-algorithms/graph/badge.svg?token=7jYcnneDys"/>
  </a>
  <a href="https://pypi.org/project/qbraid-algorithms/">
    <img src="https://img.shields.io/pypi/v/qbraid-algorithms.svg?color=blue" alt="PyPI version"/>
  </a>
  <a href="https://pypi.org/project/qbraid-algorithms/">
    <img src="https://img.shields.io/pypi/pyversions/qbraid-algorithms.svg?color=blue" alt="PyPI version"/>
  </a>
  <a href="https://www.gnu.org/licenses/gpl-3.0.html">
    <img src="https://img.shields.io/github/license/qBraid/qbraid.svg" alt="License"/>
  </a>
  <a href="https://discord.gg/TPBU2sa8Et">
    <img src="https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white" alt="Discord"/>
  </a>
</p>

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

[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qbraid-algorithms.git)

## Installation

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

```bash
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:

```bash
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:

```python
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](CONTRIBUTING.md)
- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qbraid-algorithms/issues)
- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/TPBU2sa8Et)
- For questions that are more suited for a forum, post to [Stack Exchange](https://quantumcomputing.stackexchange.com/) with the [`qbraid`](https://quantumcomputing.stackexchange.com/questions/tagged/qbraid) tag.
- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT).

## Acknowledgements

This project was conceived in cooperation with the Quantum Open Source Foundation ([QOSF](https://qosf.org/)).

<a href="https://qosf.org/"><img src="https://qbraid-static.s3.amazonaws.com/logos/qosf.png" width="100px" style="vertical-align: middle;" /></a>

## License

[GNU General Public License v3.0](LICENSE)
