mne.get_config¶

mne.get_config(key=None, default=None, raise_error=False, home_dir=None)[source]¶

Read MNE-Python preferences from environment or config file.

Parameters:

Parameters:	key : None \| str The preference key to look for. The os evironment is searched first, then the mne-python config file is parsed. If None, all the config parameters present in environment variables or the path are returned. default : str \| None Value to return if the key is not found. raise_error : bool If True, raise an error if the key is not found (instead of returning default). home_dir : str \| None The folder that contains the .mne config folder. If None, it is found automatically.
Returns:	value : dict \| str \| None The preference key value.

key : None | str

The preference key to look for. The os evironment is searched first, then the mne-python config file is parsed. If None, all the config parameters present in environment variables or the path are returned.

default : str | None

Value to return if the key is not found.

raise_error : bool

If True, raise an error if the key is not found (instead of returning default).

home_dir : str | None

The folder that contains the .mne config folder. If None, it is found automatically.

Returns:

value : dict | str | None

The preference key value.

Examples using `mne.get_config`¶

Background information on configurations

mne.get_config¶

Examples using mne.get_config¶

Examples using `mne.get_config`¶