lightcurvelynx.utils.data_download

Basic functions for downloading data using pooch.

Attributes

logger

Functions

download_data_file_if_needed(data_path, data_url[, ...])

Download a data file from a URL and save it to a specified path.

Module Contents

logger[source]
download_data_file_if_needed(data_path, data_url, force_download=False, silent=False)[source]

Download a data file from a URL and save it to a specified path.

Parameters:

  • data_path (str or Path) – The path to the data file. This is where the downloaded file will be written.

  • data_url (str) – The URL to download the data file.

  • force_download (bool, optional) – If True, the file will be downloaded even if it already exists. Default is False.

  • silent (bool, optional) – If True, suppress print statements from the download process. Default is False.

Returns:

True if the download was successful, False otherwise.

Return type:

bool