mne.datasets.sample.data_path

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

Get path to local copy of sample dataset.

Parameters

pathNone | 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_updatebool

Force update of the sample dataset even if a local copy exists. Default is False.

update_pathbool | None

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

downloadbool

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.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns

pathinstance of pathlib.Path

Path to sample dataset directory.

Examples using mne.datasets.sample.data_path

Overview of MEG/EEG analysis with MNE-Python

Overview of MEG/EEG analysis with MNE-Python