Configuration parameters for psy-view.

Classes:

PsyViewRcParams(*args, **kwargs)

RcParams for the psyplot-gui package.

class psy_view.rcsetup.PsyViewRcParams(*args, **kwargs)

Bases: RcParams

RcParams for the psyplot-gui package.

Attributes:

HEADER

Methods:

load_from_file([fname])

Update rcParams from user-defined settings

HEADER: str = 'Configuration parameters of the psyplot module\n\nYou can copy this file (or parts of it) to another path and save it as\npsyviewrc.yml. The directory should then be stored in the PSYPLOTCONFIGDIR\nenvironment variable.'

load_from_file(fname: str | None = None)

Update rcParams from user-defined settings

This function updates the instance with what is found in fname

Parameters:

fname (str) – Path to the yaml configuration file. Possible keys of the dictionary are defined by config.rcsetup.defaultParams. If None, the config.rcsetup.psyplot_fname() function is used.

See also

dump_to_file, psyplot_fname