CUDA-Q Docs Applications Section Reorg

.github/workflows/config/spellcheck_config.yml

@@ -236,6 +236,10 @@ matrix:
       # Ignore word prefixes, e.g. "pre-" in pre-computed
       - open: '(^|\s)[A-Z]?[a-z]+-'
         close: '(?=.)'
+      # Ignore apostrophy-s endings of words (e.g. NVIDIA's)
+      - open: '(?=\S)'
+        close: '($|(?=[^a-z]))'
+        content: '\u0027s'
 
 - name: python
   sources:

.github/workflows/config/spelling_allowlist.txt

@@ -27,6 +27,7 @@ DCO
 DGX
 DOI
 Deuteron
+Deutsch
 Doxygen
 FPGAs
 Fock
@@ -54,6 +55,7 @@ Jupyter
 JupyterLab
 Kagome
 Kraus
+Krylov
 LLVM
 LSB
 Libraries
@@ -99,6 +101,7 @@ QPU
 QPUs
 QPU’s
 QTX
+QX
 Qiskit
 QuEra
 QuTiP
@@ -170,7 +173,9 @@ coprocessor
 coprocessors
 copyable
 coreset
+coresets
 cortex-cli
+counterdiabatic
 coupler
 couplers
 cuQuantum
@@ -338,6 +343,7 @@ variational
 vdots
 verifier
 vertices
+vqe
 waveforms
 wavefunction
 workflow

docker/build/devdeps.Dockerfile

@@ -171,4 +171,4 @@ RUN apt-get update && apt-get install -y --no-install-recommends python3 python3
         ipython==8.15.0 pandoc==2.3 sphinx==5.3.0 sphinx_rtd_theme==1.2.0 sphinx-reredirects==0.1.2 \
         sphinx-copybutton==0.5.2 sphinx_inline_tabs==2023.4.21 enum-tools[sphinx] breathe==4.34.0 \
         nbsphinx==0.9.2 sphinx_gallery==0.13.0 myst-parser==1.0.0 ipykernel==6.29.4 notebook==7.3.2 \
-        ipywidgets==8.1.5
+        ipywidgets==8.1.5 sphinx-tags==0.4

docs/sphinx/_static/custom.css

@@ -0,0 +1,157 @@
+/*******************************************************************************
+ * Copyright (c) 2022 - 2025 NVIDIA Corporation & Affiliates.                  *
+ * All rights reserved.                                                        *
+ *                                                                             *
+ * This source code and the accompanying materials are made available under    *
+ * the terms of the Apache License 2.0 which accompanies this distribution.    *
+ *                                                                             *
+ * File: custom.css                                                            *
+ * Created Date: 16 Feb 2023                                                   *
+ * Last Modified: 16 Feb 2023                                                  *
+ ******************************************************************************/
+
+
+.notebook-entry {
+    display: grid;
+    grid-template-areas:
+        "title image"
+        "content image";
+    grid-template-columns: 1fr 300px;
+    grid-template-rows: auto 1fr;
+    gap: 20px;
+    margin-bottom: 50px;
+    padding: 20px;
+    border: 1px solid #eee;
+    background: white;
+}
+
+.notebook-title {
+    grid-area: title;
+    display: block;
+    font-size: 24px;
+    font-weight: bold;
+    text-decoration: none;
+    margin: 0;
+    padding: 0 0 10px 0;
+    color: #333;
+    border-bottom: 1px solid #eee;
+}
+
+.notebook-title:hover {
+    color: #76b900;
+    text-decoration: underline;
+}
+
+.notebook-content {
+    grid-area: content;
+    padding: 0;
+    margin: 0;
+    line-height: 1.6;
+}
+
+.notebook-image {
+    grid-area: image;
+    width: 300px;
+    height: 200px;
+    object-fit: cover;
+    justify-self: end;
+    align-self: start;
+    margin: 0;
+    border-radius: 4px;
+    box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+
+.toctree-wrapper {
+    grid-area: link;
+    margin: 10px 0 0 0;
+    padding: 0;
+}
+
+.tag-button {
+    margin: 2px;
+    padding: 8px 16px;
+    border: 1px solid #ccc;
+    background: #f8f8f8;
+    cursor: pointer;
+    border-radius: 4px;
+    transition: all 0.3s ease;
+}
+
+.tag-button.active {
+    background-color: #76b900;
+    color: white;
+    border-color: #599400;
+    box-shadow: 0 0 5px rgba(118, 185, 0, 0.3);
+}
+
+.tag-button:hover {
+    background-color: #ecffad;
+}
+
+.filter-groups {
+    margin-bottom: 40px;
+    padding: 20px;
+    background: #f9f9f9;
+    border-radius: 8px;
+}
+
+.tag-filters {
+    margin-bottom: 25px;
+}
+
+.backend-group {
+    display: inline-block;
+    position: relative;
+    margin-right: 10px;
+}
+
+.backend-options {
+    display: none;
+    position: absolute;
+    top: 100%;
+    left: 0;
+    background: white;
+    border: 1px solid #ccc;
+    border-radius: 4px;
+    padding: 8px;
+    box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+    z-index: 100;
+    min-width: 200px;
+}
+
+.backend-group:hover .backend-options {
+    display: block;
+}
+
+.backend-toggle {
+    position: relative;
+    padding-right: 24px;
+}
+
+.backend-toggle::after {
+    content: '▼';
+    position: absolute;
+    right: 8px;
+    top: 50%;
+    transform: translateY(-50%);
+    font-size: 10px;
+}
+
+.sub-option {
+    display: block;
+    width: 100%;
+    text-align: left;
+    margin: 4px 0;
+    border: none;
+    background: transparent;
+    padding: 6px 12px;
+}
+
+.sub-option:hover {
+    background-color: #f5f5f5;
+}
+
+.sub-option.active {
+    background-color: #76b900;
+    color: white;
+}

docs/sphinx/_static/filter.js

@@ -0,0 +1,112 @@
+/*******************************************************************************
+ * Copyright (c) 2022 - 2025 NVIDIA Corporation & Affiliates.                  *
+ * All rights reserved.                                                        *
+ *                                                                             *
+ * This source code and the accompanying materials are made available under    *
+ * the terms of the Apache License 2.0 which accompanies this distribution.    *
+ *                                                                             *
+ * File: filter.js                                                             *
+ * Created Date: 16 Feb 2023                                                   *
+ * Last Modified: 16 Feb 2023                                                  *
+ ******************************************************************************/
+
+
+document.addEventListener('DOMContentLoaded', function() {
+    const notebooks = document.querySelectorAll('.notebook-entry');
+    const tagButtons = document.querySelectorAll('.tag-button');
+
+    const activeFilters = {
+        domain: 'all',
+        backend: 'all',
+        occasion: 'all',
+        subFilter: 'all'
+    };
+
+    const backendCategories = {
+        noiseless: ['gpu', 'mgpu', 'mqpu'],
+        noisy: ['density'],
+        qpu: ['neutral']
+    };
+
+    tagButtons.forEach(button => {
+        button.addEventListener('click', function() {
+            const group = this.getAttribute('data-group');
+            const tag = this.getAttribute('data-tag');
+
+            if (this.classList.contains('sub-option')) {
+                if (activeFilters.subFilter === tag) {
+                    activeFilters.subFilter = 'all';
+                    activeFilters.backend = 'all';
+                    document.querySelectorAll('.sub-option, .backend-toggle').forEach(btn => 
+                        btn.classList.remove('active'));
+                    document.querySelector('.tag-button[data-tag="all"]').classList.add('active');
+                } else {
+                    activeFilters.subFilter = tag;
+                    activeFilters.backend = this.closest('.backend-group')
+                        .querySelector('.backend-toggle')
+                        .getAttribute('data-tag');
+
+                    document.querySelectorAll('.sub-option').forEach(btn =>
+                        btn.classList.toggle('active', btn.getAttribute('data-tag') === tag));
+
+                    document.querySelectorAll('.backend-toggle').forEach(toggle =>
+                        toggle.classList.toggle('active',
+                            toggle.getAttribute('data-tag') === activeFilters.backend));
+
+                    document.querySelector('.tag-button[data-tag="all"]').classList.remove('active');
+                }
+            } else if (this.classList.contains('backend-toggle')) {
+                if (activeFilters.backend === tag) {
+                    activeFilters.backend = 'all';
+                    activeFilters.subFilter = 'all';
+                    document.querySelectorAll('.backend-toggle, .sub-option').forEach(btn =>
+                        btn.classList.remove('active'));
+                    document.querySelector('.tag-button[data-tag="all"]').classList.add('active');
+                } else {
+                    activeFilters.backend = tag;
+                    activeFilters.subFilter = 'all';
+                    document.querySelectorAll('.backend-toggle').forEach(btn =>
+                        btn.classList.toggle('active', btn.getAttribute('data-tag') === tag));
+                    document.querySelectorAll('.sub-option').forEach(btn =>
+                        btn.classList.remove('active'));
+                    document.querySelector('.tag-button[data-tag="all"]').classList.remove('active');
+                }
+            } else {
+                // Handle regular filter buttons
+                if (group === 'occasion') {
+                    if (activeFilters[group] === tag) {
+                        // If clicking the same tag, reset to 'all'
+                        activeFilters[group] = 'all';
+                        this.classList.remove('active');
+                    } else {
+                        activeFilters[group] = tag;
+                        document.querySelectorAll(`.tag-button[data-group="${group}"]`)
+                            .forEach(btn => btn.classList.remove('active'));
+                        this.classList.add('active');
+                    }
+                } else {
+                    document.querySelectorAll(`.tag-button[data-group="${group}"]`)
+                        .forEach(btn => btn.classList.remove('active'));
+                    this.classList.add('active');
+                    activeFilters[group] = tag;
+                }
+
+                if (group === 'backend') {
+                    activeFilters.subFilter = 'all';
+                }
+            }
+
+            // Apply all filters
+            notebooks.forEach(notebook => {
+                const notebookTags = notebook.getAttribute('data-tags').split(',').map(t => t.trim());
+                const isVisible = Object.entries(activeFilters).every(([group, tag]) => {
+                    if (group === 'subFilter' && tag !== 'all') {
+                        return notebookTags.includes(tag);
+                    }
+                    return tag === 'all' || notebookTags.includes(tag);
+                });
+                notebook.style.display = isVisible ? 'grid' : 'none';
+            });
+        });
+    });
+});

docs/sphinx/_tags/tagsindex.rst

@@ -0,0 +1,11 @@
+:orphan:
+
+.. _tagoverview:
+
+Tags overview
+#############
+
+.. toctree::
+    :caption: Tags
+    :maxdepth: 1
+

docs/sphinx/applications/python/deutschs_algorithm.ipynb → docs/sphinx/applications/python/Deutsch_algorithm.ipynb

@@ -16,7 +16,8 @@
     "Deutsch's Algorithm is a concise demonstration of the differences in computational complexity between classical and quantum algorithms for certain problems.  For Desutch's algorithm, we begin with a function which takes in a bit and outputs a bit. This can be represented as $f: \\{0,1\\} \\longrightarrow \\{0,1\\}$. \n",
     "The function $f$ has the property that it either constant or balanced. The goal of Deutsch's Algorithm is to determine whether our given function is constant or whether it is balanced. \n",
     "\n",
-    "A constant function is \"A balanced function is a function such that the outputs are the same regardless of the inputs, i.e., if $f(0) = 0$ then $f(1) = 1$ or if $f(0) = 1$ then $f(1) = 0$.\n\", the outputs are the same regardless of the inputs, i.e., in the case of $f: \\{0,1\\} \\longrightarrow \\{0,1\\}$, there are are two ways in which this can occur: $f(0) = f(1) = 0$ or $f(0) = f(1) = 1$.\n",
+    "A constant function is \"A balanced function is a function such that the outputs are the same regardless of the inputs, i.e., if $f(0) = 0$ then $f(1) = 1$ or if $f(0) = 1$ then $f(1) = 0$.\n",
+    "\", the outputs are the same regardless of the inputs, i.e., in the case of $f: \\{0,1\\} \\longrightarrow \\{0,1\\}$, there are are two ways in which this can occur: $f(0) = f(1) = 0$ or $f(0) = f(1) = 1$.\n",
     "\n",
     "A balanced function is defined such that the ouputs are balanced across their possibilities, i.e., if $f(0) = 0$ then $f(1) = 1$ or if $f(0) = 1$ then $f(1) = 0$.\n",
     " \n",
@@ -394,7 +395,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -410,13 +411,12 @@
    "pygments_lexer": "ipython3",
    "version": "3.10.12"
   },
-  "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
     "hash": "916dbcbb3f70747c44a77c7bcd40155683ae19c65e1c03b4aa3499c5328201f1"
    }
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }