Skip to content

Document that PlotPy's configuration directory also stores custom colormaps #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PierreRaybaut merged 1 commit into from
Oct 29, 2026
Merged

Document that PlotPy's configuration directory also stores custom colormaps #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions sigimax/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2169,11 +2169,15 @@ def apply_plotpy_defaults(self) -> None:
def set_plotpy_application(
self, config_app_name: str = "", load: bool = False
) -> None:
"""Set the application name used for PlotPy's INI file.
"""Set the application name used for PlotPy's configuration directory.

This directory contains PlotPy's INI file and, with PlotPy 2.12 or later,
the custom colormaps created by the user.

Args:
config_app_name: Application name for the PlotPy INI file
(e.g., ``"MyApp_v1"``). If empty, PlotPy uses its own default.
config_app_name: Application name whose configuration directory stores
PlotPy's files, in a ``plotpy`` subdirectory (e.g., ``"MyApp_v1"``).
If empty, PlotPy's own ``.plotpy`` directory is used.
load: If True, load existing user settings from the INI file.
"""
PLOTPY_CONF.set_application(
Expand All @@ -2189,8 +2193,10 @@ def initialize_plotpy(self, config_app_name: str = "", load: bool = False) -> No
:meth:`set_plotpy_application`.

Args:
config_app_name: Application name for the PlotPy INI file
(e.g., ``"MyApp_v1"``). If empty, PlotPy uses its own default.
config_app_name: Application name whose configuration directory stores
PlotPy's files (INI file, custom colormaps), in a ``plotpy``
subdirectory (e.g., ``"MyApp_v1"``). If empty, PlotPy's own
``.plotpy`` directory is used.
load: If True, load existing user settings from the INI file.
"""
self.apply_plotpy_defaults()
Expand Down
Loading