******************************************************
cuQuantum Python: Python APIs for NVIDIA cuQuantum SDK
******************************************************

Welcome to the cuQuantum Python documentation!

**NVIDIA cuQuantum Python** provides Python bindings and high-level object-oriented models
for accessing the full functionalities of :doc:`NVIDIA cuQuantum SDK <../index>` from Python.

**Available** at https://github.com/NVIDIA/cuQuantum

.. topic:: Key Features

   * Provides 1:1 Python wrappers for all cuQuantum C APIs.
   * Includes a tensornetwork module with high-level, Pythonic APIs that support:
   
      - A computational engine for exact tensor network contraction with NumPy-style einsum semantics.
      - A converter for Cirq and Qiskit users to map quantum circuit objects to tensor network contractions.
      - Computational primitives for tensor decomposition using QR and SVD.
      - A tensor network state simulator for both exact contraction-based simulation and matrix product states (MPS) simulation.
      - Interoperability with CPU-based arrays (NumPy, PyTorch) and GPU-based arrays (CuPy, PyTorch).

   * Provides a densitymat module with high-level, Pythonic APIs for accelerating analog quantum dynamics solvers based on quantum many-body operators and density-matrix (or state-vector) formalism. 
   * Open sourced (under the BSD-3-Clause license) following the community practice for easy access
   

.. topic:: Support

   * *Supported Python versions*: 3.11, 3.12, 3.13
   * *Supported installation methods*: ``conda install``, ``pip install``, or build from source


.. topic:: Prerequisites

   * CUDA 12 & 13
   * cuStateVec 1.10.0+
   * cuTensorNet 2.8.0+
   * cuDensityMat >=0.2.0, <0.3.0
   * `NumPy`_ v1.21+
   * `CuPy`_ v13.0+
   * `nvmath-python`_ ==0.6.0
   * `cuda-bindings`_ >=12.9.1, <13.0.0 for CUDA 12 or >=13.0.0, <14.0.0 for CUDA 13
   * Optional dependencies:

     * `PyTorch`_ v1.10+
     * `Qiskit`_ >=v0.24.0, <=v1.0.0
     * `Cirq`_ v0.6.0+
     * `mpi4py`_ v3.1.0+

.. _NumPy: https://numpy.org
.. _CuPy: https://cupy.dev
.. _PyTorch: https://pytorch.org
.. _Qiskit: https://qiskit.org
.. _Cirq: https://quantumai.google
.. _mpi4py: https://mpi4py.readthedocs.io
.. _nvmath-python: https://docs.nvidia.com/cuda/nvmath-python/latest/index.html
.. _cuda-bindings: https://nvidia.github.io/cuda-python/cuda-bindings/latest/

.. toctree::
   :caption: Contents
   :maxdepth: 2

   release-notes
   overview
   Utility APIs <utilities>
   bindings
   densitymat
   tensornet
   jax
   Code of Conduct <CODE_OF_CONDUCT.md>
   Contributing <CONTRIBUTING.md>