***************************************************************************
cuStateVec: A High-Performance Library for State Vector Quantum Simulators
***************************************************************************

Welcome to the cuStateVec documentation!

**NVIDIA cuStateVec** is a high-performance library dedicated to operations with state vectors for expressing quantum algorithms.
cuStateVec is a component of the `NVIDIA cuQuantum SDK <../../index.html#http://>`_.

**Download:** https://developer.nvidia.com/cuQuantum-downloads

============
Key Features
============

* Provide APIs for:

  * Gate application
  * Measurement
  * Expectation
  * Sampling

..
  * Multi-GPU APIs:
  * Qubit reordering capability to minimize communication among GPUs

=======
Support
=======

* *Supported GPU Architectures*: ``Volta`` and ``Ampere``
* *Supported OSes*: ``Linux``
* *Supported CPU Architectures*: ``x86_64``, ``ARM64``

=============
Prerequisites
=============

* `CUDA 11.4 toolkit (or above) <https://developer.nvidia.com/cuda-downloads>`_ and compatible driver (see `CUDA Driver Release Notes <https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html#cuda-major-component-versions>`_).
* `NVIDIA HPC SDK v21.7 (or above) <https://developer.nvidia.com/nvidia-hpc-sdk-downloads>`_

=====
Index
=====

.. toctree::
   :maxdepth: 1

   Back to cuQuantum <../../index.html#http://>
   release_notes
   overview
   getting_started
   api/index
   Software License Agreement <../../license.html#http://>

..
   DO NOT remove the above http suffix! It's a hack to work around Sphinx's
   limitation, see https://stackoverflow.com/a/31820846/2344149 for explanation.
   Once the official doc is up, we can drop this hack and replace it with the full url.