adding documentation

docs/source/Mapping.ipynb

@@ -263,6 +263,35 @@
     "\n",
     "qc_mapped_w_teleport.draw(output=\"mpl\")"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Visualizing search graphs\n",
+    "\n",
+    "For deeper insight into a specific mapping process one can visualize the search graphs generated during heuristic mapping."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from mqt import qmap\n",
+    "\n",
+    "visualizer = qmap.visualization.SearchVisualizer()\n",
+    "qc_mapped, res = qmap.compile(qc, arch, method=\"heuristic\", visualizer=visualizer)\n",
+    "visualizer.visualize_search_graph()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "There exist a wide range of customizations for these visualizations. Please refer to the API reference for details."
+   ]
   }
  ],
  "metadata": {
@@ -280,7 +309,8 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

docs/source/library/Library.rst

@@ -10,3 +10,4 @@ Library
    Subarchitectures
    Synthesis
    SynthesisResults
+   Visualization

docs/source/library/Visualization.rst

@@ -0,0 +1,16 @@
+Visualization
+===========================
+
+All visualization functionality is bundled in the sub-module :code:`mqt.qmap.visualization`. 
+
+Search graph visualization
+############################
+
+The recommended way to visualize search graphs of a mapping process is via a :code:`SearchVisualizer` object, which can be passed to the :code:`compile` function when mapping a circuit to enable data logging during mapping, after which this data can be visualized by calling the method :code:`visualize_search_graph` of the :code:`SearchVisualizer` object.
+Closing the :code:`SearchVisualizer` object will cleanup the data logged during mapping, which will however also be done automatically when the python process terminates (if not custom data logging path is used).
+
+    .. note::
+        :code:`visualize_search_graph` returns an IPython display object and therefore requires to be executed in a jupyter notebook or jupyter lab environment.
+
+    .. currentmodule:: mqt.qmap.visualization
+    .. autoclass:: SearchVisualizer