***********************************************************************
cuTensorNet: A High-Performance Library for Tensor Network Computations
***********************************************************************

Welcome to the cuTensorNet library documentation!

**NVIDIA cuTensorNet** is a high-performance library for tensor network computations,
a component of the :doc:`NVIDIA cuQuantum SDK <../index>`.

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

..
  TODO: mention what cuTensorNet can be used in addition to quantum circuit simulations.
  We don't want to limit ourselves in quantum information science. Tensor networks can
  be used in many areas beyond that.


.. topic:: Key Features

   * Based on NVIDIA's high-performance tensor linear algebra library: `cuTENSOR <https://developer.nvidia.com/cutensor>`_
   * Provides APIs for:
   
     - Creating a tensor network
     - Finding a low-cost path for any given tensor network contraction
     - Finding a low-cost slicing to meet specified memory constraints
     - Tuning the path finder's configuration for better performance
     - Performing tensor network contractions
     - Logging 
   
   ..
     * Multi-GPU APIs:
     * Qubit reordering capability to minimize communication among GPUs


.. topic:: Support

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


.. topic:: Prerequisites

   * `CUDA Toolkit v11.4 (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>`_).
   * `cuTENSOR v1.4.0 (or above) <https://developer.nvidia.com/cutensor>`_
   * `NVIDIA HPC SDK v21.11 (or above) <https://developer.nvidia.com/nvidia-hpc-sdk-downloads>`_


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

   release_notes
   overview
   getting_started
   api/index
   acknowledgements