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.copy_file(path, data_dir, overwrite=False, verbose=0)[source]¶

Copy the requested file if needed or requested.

Parameters

path : str

the path to the file to be downloaded.

data_dir : str

path of the data directory.

overwrite : bool (optional, default False)

if True and file already exists, delete it.

verbose : int (optional, default 0)

control the verbosity level.

Returns

copy_file : str

absolute path to the copied file.