.. _python-api-reference-label:

API Reference
==============

This reference describes all Python components of the cuStateVec, cuTensorNet and cuDensityMat libraries.

.. module:: cuquantum

cuQuantum (:mod:`cuquantum`)
----------------------------

.. toctree::
   :maxdepth: 2

   cuquantum


.. module:: cuquantum.custatevec

cuStateVec (:mod:`cuquantum.custatevec`)
----------------------------------------

.. toctree::
   :maxdepth: 2

   custatevec


.. module:: cuquantum.cutensornet

cuTensorNet (:mod:`cuquantum.cutensornet`)
------------------------------------------

.. toctree::
   :maxdepth: 2

   cutensornet

.. module:: cuquantum.bindings

Bindings for cuQuantum C Libraries (:mod:`cuquantum.bindings`)
--------------------------------------------------------------

.. toctree::
   :maxdepth: 2

   bindings/cudensitymat

.. module:: cuquantum.cutensornet.experimental

cuTensorNet experimental feature (:mod:`cuquantum.cutensornet.experimental`)
----------------------------------------------------------------------------

.. toctree::
   :maxdepth: 2

   cutensornet.experimental


.. module:: cuquantum.cutensornet.tensor

cuTensorNet tensor factorization (:mod:`cuquantum.cutensornet.tensor`)
----------------------------------------------------------------------

This module is also made available as ``cuquantum.tensor`` for convenience.

.. toctree::
   :maxdepth: 2

   cutensornet.tensor

.. module:: cuquantum.densitymat

cuDensityMat Pythonic API (:mod:`cuquantum.densitymat`)
-------------------------------------------------------

.. toctree::
   :maxdepth: 2

   densitymat