fix: Fixing documentation

qiboteam · May 31, 2024 · 01c99e8 · 01c99e8
1 parent dfbad7f
commit 01c99e8
Show file tree

Hide file tree

Showing 10 changed files with 224 additions and 351 deletions.
diff --git a/doc/source/code-examples/applications-by-algorithm.rst b/doc/source/code-examples/applications-by-algorithm.rst
@@ -78,14 +78,11 @@ Diagonalization Algorithms
 
     tutorials/dbi/README.md
 
-    .. tutorials/dbi/dbi_tutorial_basic_intro.ipynb
-
-    tutorials/dbi/dbi_scheduling.ipynb
-    tutorials/dbi/dbi_cost_functions_and_d_gradients_tutorial.ipynb
+    tutorials/dbi/dbi_cost_functions.ipynb
     tutorials/dbi/dbi_gradient_descent_strategies.ipynb
     tutorials/dbi/dbi_group_commutator_tests.ipynb
-
-    .. tutorials/dbi/dbi_gdbi_strategies_compare.ipynb
-
+    tutorials/dbi/dbi_scheduling.ipynb
+    tutorials/dbi/dbi_strategies_compare.ipynb
     tutorials/dbi/dbi_strategy_Ising_model.ipynb
     tutorials/dbi/dbi_strategy_Pauli-Z.ipynb
+    tutorials/dbi/dbi_tutorial_basic_intro.ipynb
diff --git a/doc/source/code-examples/tutorials/dbi/dbi_cost_functions.ipynb b/doc/source/code-examples/tutorials/dbi/dbi_cost_functions.ipynb
@@ -0,0 +1 @@
+../../../../../examples/dbi/dbi_cost_functions.ipynb
diff --git a/doc/source/code-examples/tutorials/dbi/dbi_cost_functions_and_d_gradients_tutorial.ipynb b/doc/source/code-examples/tutorials/dbi/dbi_cost_functions_and_d_gradients_tutorial.ipynb
diff --git a/...als/dbi/dbi_gdbi_strategies_compare.ipynb → ...utorials/dbi/dbi_strategies_compare.ipynb b/...als/dbi/dbi_gdbi_strategies_compare.ipynb → ...utorials/dbi/dbi_strategies_compare.ipynb
diff --git a/double_bracket_flow_as_a_diagonalization_quantum_algorithm b/double_bracket_flow_as_a_diagonalization_quantum_algorithm
diff --git a/examples/dbi/dbi_cost_functions.ipynb b/examples/dbi/dbi_cost_functions.ipynb
diff --git a/examples/dbi/dbi_strategies_compare.ipynb b/examples/dbi/dbi_strategies_compare.ipynb
@@ -9,11 +9,6 @@
     "This notebook is a comparison of the so-far developed diagonalization strategies for DBI, including the canonical, Pauli-Z, and magnetic field strategies. On top of these, we also show case the use of invariant DBI generators such as 'BHMM'."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -449,6 +444,13 @@
     "plt.ylabel(r'$|| \\sigma(e^{sW}He^{-sW}) || $')"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/examples/dbi/dbi_tutorial_basic_intro.ipynb b/examples/dbi/dbi_tutorial_basic_intro.ipynb
@@ -21,8 +21,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!python -m pip install seaborn # plotting library\n",
-    "!python -m pip install hyperopt # required to optimize the DBF step"
+    "# uncomment this line if seaborn is not installed\n",
+    "# !python -m pip install seaborn # plotting library"
    ]
   },
   {
@@ -553,7 +553,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.7"
+   "version": "3.11.4"
   }
  },
  "nbformat": 4,

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -55,6 +55,7 @@ sphinx-markdown-tables = "^0.0.17"
 sphinx-copybutton = "^0.5.2"
 nbsphinx = "^0.8.12"
 ipython = "^8.10.0"
+seaborn = "^0.13.2"
 
 [tool.poetry.group.tests]
 optional = true
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		../../../../../examples/dbi/dbi_cost_functions.ipynb