Python Sparse data Analysis Package

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the gallery for the big picture.

pysap.data.download_file(url, data_dir, resume=True, overwrite=False, verbose=0)[source]¶

Load requested file if needed or requested.

Parameters

url : str

the url of the file to be downloaded.

data_dir : str

path of the data directory.

resume : bool (optional, default True)

if True, try to resume partially downloaded files

overwrite : bool (optional, default False)

if True and file already exists, delete it.

verbose : int (optional, default 0)

control the verbosity level.

Returns

download_fname : str

absolute path to the downloaded file.

Note : If, for any reason, the download procedure fails, all downloaded

files are removed.