diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst index 3d28fd3ac..e203f80c7 100644 --- a/docs/apidocs/index.rst +++ b/docs/apidocs/index.rst @@ -15,5 +15,6 @@ Qiskit Dynamics API Reference signals pulse perturbation + arraylias array dispatch diff --git a/docs/conf.py b/docs/conf.py index dc1acc5ad..a2284016a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,7 +65,8 @@ autoclass_content = "both" intersphinx_mapping = { "qiskit": ("https://docs.quantum.ibm.com/api/qiskit", None), - "qiskit_experiments": ("https://qiskit-extensions.github.io/qiskit-experiments/", None) + "qiskit_experiments": ("https://qiskit-extensions.github.io/qiskit-experiments/", None), + "arraylias": ("https://qiskit-extensions.github.io/arraylias/", None) } # nbsphinx options (for tutorials) diff --git a/qiskit_dynamics/arraylias/__init__.py b/qiskit_dynamics/arraylias/__init__.py index 0072f114b..ff0a43203 100644 --- a/qiskit_dynamics/arraylias/__init__.py +++ b/qiskit_dynamics/arraylias/__init__.py @@ -13,13 +13,27 @@ # that they have been altered from the originals. r""" -========================================= -Models (:mod:`qiskit_dynamics.arraylias`) -========================================= +============================================ +Arraylias (:mod:`qiskit_dynamics.arraylias`) +============================================ .. currentmodule:: qiskit_dynamics.arraylias -Module for Qiskit Dynamics global NumPy and SciPy aliases. +Qiskit Dynamics uses `Arraylias `_ to manage +dispatching of array operations for different array types coming from different array libraries. + +This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases +provided by Arraylias `_, which have been configured +to support the `JAX `_ `BCOO` sparse array type, as well as +the sparse types offered by SciPy. + +.. autosummary:: + :toctree: ../stubs/ + + DYNAMICS_NUMPY_ALIAS + DYNAMICS_SCIPY_ALIAS + DYNAMICS_NUMPY + DYNAMICS_SCIPY """ from .alias import (