mne.datasets.sample.data_path

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

Get path to local copy of sample dataset.

Parameters:
path : None | str

Location of where to look for the sample dataset. If None, the environment variable or config parameter MNE_DATASETS_SAMPLE_PATH is used. If it doesn’t exist, the “~/mne_data” directory is used. If the sample 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 sample dataset even if a local copy exists.

update_path : bool | None

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

download : bool

If False and the sample 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()).

Returns:
path : str

Path to sample dataset directory.

Examples using mne.datasets.sample.data_path