Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.08 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.08 KB

PyPI version Ruff

Qoin

qoin is the analogue of random package implemented through gate-based quantum computing.

Getting Started

Prerequisites

  • Python 3.9+

Installation

qoin can be installed with the command :

pip install qoin

The default installation of qoin includes numpy, qiskit, and qiskit_aer.

Usage

The docs/examples are a good way for understanding how the package works.

from qoin import QRNG


random_generator = QRNG()
random_generator.randint(5, 10)

Testing

Run all tests with the command:

py -m pytest tests

Note: if you have installed in a virtual environment, remember to install pytest in the same environment using:

pip install pytest

Documentation

To generate the documentation, run commands:

cd docs
.\make html

License

The package is released under the GPL Ver 3.0 license.