This documentation is for development version 0.18.dev0.

mne.datasets.multimodal.data_path

mne.datasets.multimodal.data_path(path=None, force_update=False, update_path=True, download=True, verbose=None)[source]

Get path to local copy of multimodal dataset.

Parameters:
path : None | str

Location of where to look for the multimodal dataset. If None, the environment variable or config parameter MNE_DATASETS_MULTIMODAL_PATH is used. If it doesn’t exist, the “~/mne_data” directory is used. If the multimodal dataset is not found under the given path, the data will be automatically downloaded to the specified folder.

force_update : bool

Force update of the multimodal dataset even if a local copy exists.

update_path : bool | None

If True, set the MNE_DATASETS_MULTIMODAL_PATH in mne-python config to the given path. If None, the user is prompted.

download : bool

If False and the multimodal dataset has not been downloaded yet, it will not be downloaded and the path will be returned as ‘’ (empty string). This is mostly used for debugging purposes and can be safely ignored by most users.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
path : str

Path to multimodal dataset directory.

Examples using mne.datasets.multimodal.data_path