.. This file is part of Sympathy for Data.
.. Copyright (c) 2023 Combine Control Systems AB
..
.. Sympathy for Data is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, version 3 of the License.
..
.. Sympathy for Data is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with Sympathy for Data.  If not, see <http://www.gnu.org/licenses/>.

.. _graphviz:

Graphviz
--------

Graphviz is open source graph visualization software. Graph visualization is a
way of representing structural information as diagrams of abstract graphs and
networks. Visit https://graphviz.org for more information.

Graphviz can be used in Sympathy for Data to visualize profiling call graphs and
decisiontrees for machinlearning models. To start using Graphviz, it must be
installed and then configured. This is completely optional and necessary only to
enable these visualizations.

.. _`install_gv`:

Installing Graphviz
^^^^^^^^^^^^^^^^^^^

To obtain a copy of Graphviz, visit: http://www.graphviz.org. Install it and
note the install folder, which will be needed when :ref:`conf_gv`.

.. _`conf_gv`:

Configuring Graphviz
^^^^^^^^^^^^^^^^^^^^

For the call graph file to be generated Graphviz will have to be
:ref:`installed <install_gv>` and the path to the bin folder which contains dot
will have to be in either PATH or *Graphviz install path*, see :ref:`Debug
Preferences<preferences_debug>`.