******************************************************
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

   * Provide 1:1 Python wrappers for all cuQuantum C APIs
   * Provide high-level, pythonic objects for creating and manipulating tensor networks

     * Interoperable with both CPU (NumPy, PyTorch) and GPU (CuPy, PyTorch) arrays

   * Provide a converter for Cirq and Qiskit users to map quantum circuits objects to tensor network contractions
   * Open sourced (under the BSD-3-Clause license) following the community practice for easy access
   

.. topic:: Support

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


.. topic:: Prerequisites

   * CUDA 11 & 12
   * cuStateVec 1.6.0+
   * cuTensorNet 2.5.0+
   * `NumPy`_ v1.21+
   * `CuPy`_ v13.0+
   * 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


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

   release-notes
   overview
   Running Examples <running-examples.md>
   Code of Conduct <CODE_OF_CONDUCT.md>
   Contributing <CONTRIBUTING.md>
   api/index