mne.datasets.brainstorm.bst_resting.data_path#

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

Get path to local copy of brainstorm (bst_resting) dataset.

Parameters:

pathNone | str

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

force_updatebool

Force update of the brainstorm (bst_resting) dataset even if a local copy exists. Default is False.

update_pathbool | None

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

downloadbool

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

acceptbool

If True (default False), accept the license terms of this dataset.

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 brainstorm (bst_resting) dataset directory.