.. This file is part of Sympathy for Data.
.. Copyright (c) 2020 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/>.


.. _preferences_dialog:

Preferences
===========

The Preferences dialog is found in the main menu of Sympathy as *Preferences*,
on Windows as *File* -> *Preferences*.

Generally, the options shown and configured are global and tied to the settings.
As a side note, settings are stored in a file called Sympathy.ini under the
current Sympathy user's folder. 


.. _preferences_general:

General
-------

Section dedicated to the main user interface and behavior of Sympathy.


.. _preferences_node_libraries:

Node Libraries
--------------

Shows the current global node libraries.

Global node libraries that have been added by selecting its folder on disk are
shown and configured in this Section.

Global node libraries that have been added by installing Python packages into
the Python environment are shown but can not be added or removed in this
section. They are normally, managed outside of Sympathy by installing and
uninstalling their corresponding python packages through pip, etc.


.. _preferences_environment:

Environment
-----------

Shows the global environment variables, these are stored in settings and can
be configured.

Additionally, this section shows the external environment variables (called
Environment variables). These might come from settings in the operating system
or the shell used to start Sympathy, etc. External environment variables can
only be viewed but not configured.


.. _preferences_debug:

Debug
-----

Shows options for configuring the profiler and its output. Profiling requires
the Graphviz executable (dot), and its location can be specified here. Or
by making it available through PATH.

To obtain a copy of Graphviz, visit: http://www.graphviz.org.

.. figure:: graphviz_setting.png
   :alt: Setting GraphViz path in preferences.


.. _preferences_advanced:

Advanced
--------

Shows advanced options that users should not normally need to configure.
Notably an option to configure the number of worker processes and to disable
or enable deprecation warnings.