Metadata-Version: 2.4
Name: cuquantum-python-jax
Version: 0.0.7
Summary: NVIDIA cuQuantum Python JAX
Home-page: https://developer.nvidia.com/cuquantum-sdk
Author: NVIDIA Corporation
Author-email: cuquantum-python@nvidia.com
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/NVIDIA/cuQuantum/issues
Project-URL: User Forum, https://github.com/NVIDIA/cuQuantum/discussions
Project-URL: Documentation, https://docs.nvidia.com/cuda/cuquantum/latest/python/jax.html
Project-URL: Source Code, https://github.com/NVIDIA/cuQuantum
Keywords: cuda,nvidia,state vector,tensor network,high-performance computing,quantum computing
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Environment :: GPU :: NVIDIA CUDA :: 12
Classifier: Environment :: GPU :: NVIDIA CUDA :: 13
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

**********************
cuQuantum Python JAX
**********************

cuQuantum Python JAX provides a JAX extension for cuQuantum Python. It exposes selected functionalities of
cuQuantum SDK in a JAX-compatible way that enables JAX frameworks to directly interface with the exposed
cuQuantum API. In the current release, cuQuantum JAX exposes JAX interfaces to the Operator Action API from
the cuDensityMat library and the GF(2) sparse-dense matrix multiplication from the cuStabilizer library.

Documentation
=============

For detailed guide, please refer to `cuQuantum Python JAX documentation <https://docs.nvidia.com/cuda/cuquantum/latest/python/jax.html>`_.

Installation
============

.. code-block:: bash

   pip install -v --no-cache-dir cuquantum-python-jax

.. note::

   This package is a meta package pointing to ``cuquantum-python-jax-cuXX``,
   where XX is the CUDA major version (currently CUDA 12 & 13 are supported).
   The meta package will attempt to infer and install the correct ``-cuXX`` wheel.
   The auto-detection mechanism is not guaranteed to work in certain environments, and users are encouraged to install the new wheels that
   come *with* the ``-cuXX`` suffix.

   The argument ``--no-cache-dir`` is required for pip 23.1+. It forces pip to execute the
   auto-detection logic.


Citing cuQuantum
================

`H. Bayraktar et al., "cuQuantum SDK: A High-Performance Library for Accelerating Quantum Science," 2023 IEEE International Conference on Quantum Computing and Engineering (QCE), Bellevue, WA, USA, 2023, pp. 1050-1061, doi: 10.1109/QCE57702.2023.00119 <https://doi.org/10.1109/QCE57702.2023.00119>`_
