metabci.brainda.utils.download module

metabci.brainda.utils.download.mne_data_path(url: str, sign: str, path: str | Path | None = None, proxies: Dict[str, str] | None = None, force_update: bool = False, update_path: bool = True, verbose: bool | str | int | None = None, **kwargs) → str[source]

Get the local path of the target file.

This function returns the local path of the target file, downloading it if needed or requested. The local path keeps the same structure as the url.

Parameters:

  • url (str) – url of the target file.

  • sign (str) – the unique identifier to which the file belongs

  • path (Optional[Union[str, Path]], optional) – local folder to save the file, by default None

  • proxies (Optional[Dict[str, str]], optional) – use proxies to download files, e.g. {‘https’: ‘socks5://127.0.0.1:1080’}, by default None

  • force_update (bool, optional) – whether to re-download the file, by default False

  • update_path (bool, optional) – whether to update mne config, by default True

  • verbose (Optional[Union[bool, str, int]], optional) – [description], by default None

Returns:

local path of the target file

Return type:

str