mne.datasets.ucl_opm_auditory.data_path#

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

Get path to local copy of ucl_opm_auditory dataset.

Parameters:
pathNone | str

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

force_updatebool

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

update_pathbool | None

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

downloadbool

If False and the ucl_opm_auditory 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 ucl_opm_auditory dataset directory.