..  -*- coding: utf-8 -*-

.. _contents:


====================
Getting Started
====================

Introduction
====================

uniform Quantum Random Number Generation (uQRNG) from Quantum Computing Inc. (QCi) can be utilized to enhance security or to fuel true random simulations. This hardware implements a photonic-based quantum random number generation method. It exploits inherent randomness through the stochastic process of detecting single photons in superposition of time modes. The :code:`uqrng-direct` Python package provides a framework for direct integration to use and monitor QCi's uQRNG device. For more information on setting up QCi's uQRNG hardware and it's function see the `uQRNG User Guide <https://quantumcomputinginc.com/learn/spec-sheets/uqrng-user-guide>`_.

Installation
===============

Python package is availble from PyPI repository and can be installed by:

.. code-block:: bash

  pip install uqrng-direct


Table of Contents
=================

.. toctree::
   :maxdepth: 3

   self
   usage
   modules
   dependencies
