qpe_toolbox
===========

.. py:module:: qpe_toolbox

.. autoapi-nested-parse::

   QPE Toolbox: A Quantum Phase Estimation Toolbox.

   Documentation is available in the doscstrings and online
   at https://quobly-sw.github.io/qpe-toolbox/

   Subpackages must be explicitly imported:
   ::

   - qpe_toolbox.circuit           --- creation and manipulation of `quimb` circuits.
   - qpe_toolbox.estimation        --- perform different flavors of Quantum Phase Estimation.
   - qpe_toolbox.hamiltonian       --- class for defining Hamiltonians and interface with `pyscf` for chemistry.
   - qpe_toolbox.tensor            --- manipulation of Matrix Product Operators (MPO) and Matrix Product States (MPS).



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/qpe_toolbox/circuit/index
   /autoapi/qpe_toolbox/estimation/index
   /autoapi/qpe_toolbox/hamiltonian/index
   /autoapi/qpe_toolbox/tensor/index


Attributes
----------

.. autoapisummary::

   qpe_toolbox.EXACT


Package Contents
----------------

.. py:data:: EXACT

   Sentinel constant for requesting exact computation.

   Use ``EXACT`` to replace an approximation in real world quantum computation
   (e.g., time evolution or sampling)