1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# Authors: Alexandre Gramfort <alexandre.gramfort@telecom-paristech.fr>
# Martin Luessi <mluessi@nmr.mgh.harvard.edu>
# Eric Larson <larson.eric.d@gmail.com>
# Denis Egnemann <denis.engemann@gmail.com>
# License: BSD Style.
from ..externals.six import string_types
import os
import os.path as op
import shutil
import tarfile
from warnings import warn
from .. import __version__ as mne_version
from ..utils import get_config, set_config, _fetch_file, logger
_doc = """Get path to local copy of {name} dataset
Parameters
----------
path : None | str
Location of where to look for the {name} dataset.
If None, the environment variable or config parameter
{conf} is used. If it doesn't exist, the
"mne-python/examples" directory is used. If the sample dataset
is not found under the given path (e.g., as
"mne-python/examples/MNE-{name}-data"), 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 {conf} in mne-python
config to the given path. If None, the user is prompted.
download : bool
If False and the {name} 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 {name} dataset directory.
"""
def _dataset_version(path, name):
"""Get the version of the dataset"""
ver_fname = op.join(path, 'version.txt')
if op.exists(ver_fname):
fid = open(ver_fname, 'r')
version = fid.readline().strip() # version is on first line
fid.close()
else:
# Sample dataset versioning was introduced after 0.3
# SPM dataset was introduced with 0.7
version = '0.3' if name == 'sample' else '0.7'
return version
def _data_path(path=None, force_update=False, update_path=True,
download=True, name=None, check_version=True, verbose=None):
"""Aux function
"""
key = {'sample': 'MNE_DATASETS_SAMPLE_PATH',
'spm': 'MNE_DATASETS_SPM_FACE_PATH',
'somato': 'MNE_DATASETS_SOMATO_PATH',}[name]
if path is None:
# use an intelligent guess if it's not defined
def_path = op.realpath(op.join(op.dirname(__file__),
'..', '..', 'examples'))
# backward compatibility
if get_config(key) is None:
key = 'MNE_DATA'
path = get_config(key, def_path)
# use the same for all datasets
if not op.exists(path) or not os.access(path, os.W_OK):
try:
os.mkdir(path)
except OSError:
try:
logger.info("Checking for dataset in '~/mne_data'...")
path = op.join(op.expanduser("~"), "mne_data")
if not op.exists(path):
logger.info("Trying to create "
"'~/mne_data' in home directory")
os.mkdir(path)
except OSError:
raise OSError("User does not have write permissions "
"at '%s', try giving the path as an argument "
"to data_path() where user has write "
"permissions, for ex:data_path"
"('/home/xyz/me2/')" % (path))
if not isinstance(path, string_types):
raise ValueError('path must be a string or None')
if name == 'sample':
archive_name = "MNE-sample-data-processed.tar.gz"
url = "ftp://surfer.nmr.mgh.harvard.edu/pub/data/MNE/" + archive_name
folder_name = "MNE-sample-data"
folder_path = op.join(path, folder_name)
elif name == 'spm':
archive_name = 'MNE-spm-face.tar.bz2'
url = 'ftp://surfer.nmr.mgh.harvard.edu/pub/data/MNE/' + archive_name
folder_name = "MNE-spm-face"
folder_path = op.join(path, folder_name)
elif name == 'somato':
archive_name = 'MNE-somato-data.tar.gz'
url = 'ftp://surfer.nmr.mgh.harvard.edu/pub/data/MNE/' + archive_name
folder_name = "MNE-somato-data"
folder_path = op.join(path, folder_name)
else:
raise ValueError('Sorry, the dataset "%s" is not known.' % name)
rm_archive = False
martinos_path = '/cluster/fusion/sample_data/' + archive_name
neurospin_path = '/neurospin/tmp/gramfort/' + archive_name
if not op.exists(folder_path) and not download:
return ''
if not op.exists(folder_path) or force_update:
logger.info('Downloading or reinstalling '
'data archive %s at location %s' % (archive_name, path))
if op.exists(martinos_path):
archive_name = martinos_path
elif op.exists(neurospin_path):
archive_name = neurospin_path
else:
archive_name = op.join(path, archive_name)
rm_archive = True
fetch_archive = True
if op.exists(archive_name):
msg = ('Archive already exists. Overwrite it (y/[n])? ')
answer = raw_input(msg)
if answer.lower() == 'y':
os.remove(archive_name)
else:
fetch_archive = False
if fetch_archive:
_fetch_file(url, archive_name, print_destination=False)
if op.exists(folder_path):
shutil.rmtree(folder_path)
logger.info('Decompressing the archive: ' + archive_name)
logger.info('... please be patient, this can take some time')
for ext in ['gz', 'bz2']: # informed guess (and the only 2 options).
try:
tarfile.open(archive_name, 'r:%s' % ext).extractall(path=path)
break
except tarfile.ReadError as err:
logger.info('%s is %s trying "bz2"' % (archive_name, err))
if rm_archive:
os.remove(archive_name)
path = op.abspath(path)
if update_path is None:
if get_config(key, '') != path:
update_path = True
msg = ('Do you want to set the path:\n %s\nas the default '
'sample dataset path in the mne-python config [y]/n? '
% path)
answer = raw_input(msg)
if answer.lower() == 'n':
update_path = False
else:
update_path = False
if update_path is True:
set_config(key, path)
path = op.join(path, folder_name)
# compare the version of the Sample dataset and mne
data_version = _dataset_version(path, name)
try:
from distutils.version import LooseVersion as LV
except:
warn('Could not determine sample dataset version; dataset could\n'
'be out of date. Please install the "distutils" package.')
else: # 0.7 < 0.7.git shoud be False, therefore strip
if check_version and LV(data_version) < LV(mne_version.strip('.git')):
warn('The {name} dataset (version {current}) is older than '
'mne-python (version {newest}). If the examples fail, '
'you may need to update the {name} dataset by using '
'mne.datasets.{name}.data_path(force_update=True)'.format(
name=name, current=data_version, newest=mne_version))
return path
def has_dataset(name):
"""Helper for sample dataset presence"""
endswith = {'sample': 'MNE-sample-data',
'spm': 'MNE-spm-face',
'somato': 'MNE-somato-data'}[name]
dp = _data_path(download=False, name=name, check_version=False)
return dp.endswith(endswith)
|
