mne.get_config#
- mne.get_config(key=None, default=None, raise_error=False, home_dir=None, use_env=True)[source]#
Read MNE-Python preferences from environment or config file.
- Parameters:
- key
None
|str
The preference key to look for. The os environment 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. If key is an empty string, a list of all valid keys (but not values) is 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.
- use_env
bool
If True, consider env vars, if available. If False, only use MNE-Python configuration file values.
New in version 0.18.
- key
- Returns:
See also
Examples using mne.get_config
#
Configuring MNE-Python