visbrain.io.download_file

visbrain.io.download_file(name, astype=None, filename=None, to_path=None, unzip=False, remove_archive=False, use_pwd=False)[source][source]

Download a file.

By default this function download a file to ~/visbrain_data.

Parameters:
name : string

Name of the file to download or url.

astype : str | None

If name is a name of a file that can be downloaded, astype refer to the type of the file.

filename : string | None

Name of the file to be saved in case of url.

to_path : string | None

Download file to the path specified.

unzip : bool | False

Unzip archive if needed.

remove_archive : bool | False

Remove archive after unzip.

use_pwd : bool | False

Download the file to the current directory.
Returns:
path_to_file : string

Path to the downloaded file.