Configuration of the GUI
As psyplot is configured by the psyplot.config.rcsetup.rcParams,
psyplot-gui is configured by the psyplot_gui.config.rcsetup.rcParams
dictionary.
Both dictionaries can also be modified through the Preferences widget (on MacOS, Command+,, on Windows and Linux: ).
As for psyplot, the rcParams are stored in the psyplot configuration
directory, which is, under Linux and OSX by default, located at
$HOME/.config/psyplot/psyplotguirc.yml and under Windows at
$HOME/.psyplot/psyplotguirc.yml.
This file might look like
In [1]: from psyplot_gui import rcParams
In [2]: print(rcParams.dump())
# Configuration parameters of the psyplot module
#
# You can copy this file (or parts of it) to another path and save it as
# psyplotguirc.yml. The directory should then be stored in the PSYPLOTCONFIGDIR
# environment variable.
#
# psyplot gui version: 1.5.0
#
# Created with python
#
# 3.9.19 (main, Mar 20 2024, 20:37:44)
# [GCC 12.2.0]
#
#
# Backend to use when using the graphical user interface. The current backend is used and no changes are made. Note that it is usually not possible to change the backend after importing the psyplot.project module. The default backend embeds the figures into the
backend: psyplot
# If True, then the 'mp' variable in the console is automatically set when the current main project changes
console.auto_set_mp: true
# If True, then the 'sp' variable in the console is automatically set when the current sub project changes
console.auto_set_sp: true
# Whether the console shall be connected to the help_explorer or not
console.connect_to_help: true
# Start the different channels of the KernelClient
console.start_channels: true
# If True, a lazy load is performed on the arrays and data sets and their string representation is displayed as tool tip. This part of the data into memory. It is recommended to set this to False for remote data.
content.load_tooltips: true
# If True, the formatoptions in the Formatoptions widget are sorted by their formatoption key rather than by their name.
fmt.sort_by_key: true
# Switch that controls whether the online functions of the help explorer shall be enabled. False implies that help_explorer.use_intersphinx is set to False
help_explorer.online: null
# Boolean whether the html docs are rendered in a separate process
help_explorer.render_docs_parallel: true
# Use the intersphinx extension and link to the online documentations of matplotlib, pyplot, psyplot, numpy, etc. when converting rst docstrings. The inventories are loaded when the first object is documented. If None, intersphinx is only used when `help_explorer.online` is True and you are not using windows
help_explorer.use_intersphinx: null
# Enable the PyQt5.QtWebEngineWidgets.QWebEngineView which might not work under certain circumstances.
help_explorer.use_webengineview: true
# If True and the psyplot gui is already running, new files are opened in that gui
main.listen_to_port: true
# The port number used when new files are opened
main.open_files_port: 30124
# The opengl implementation to use. Should be one of 'software', 'desktop', 'gles' or 'automatic'.
main.opengl: software
# The plugins to exclude from loading. Can be either 'all' to exclude all plugins or a list like in 'plugins.include'.
plugins.exclude: []
# The plugins to load. Can be either None to load all that are not explicitly excluded by the 'plugins.exclude' key or a list of plugins to include. List items can be either module names, plugin names or the module name and widget via '<module_name>:<widget>'
plugins.include: null