caterva2.download#

caterva2.download(path, urlbase='http://localhost:8002/', auth_cookie=None)#

Download a dataset to storage.

Note: If the dataset is a regular file, it will be downloaded and decompressed if Blosc2 is installed. Otherwise, it will be downloaded as-is from the internal caches (i.e. compressed with Blosc2, and with the .b2 extension).

Parameters:
  • path (str) – The path of the dataset.

  • urlbase (str) – The base of URLs (slash-terminated) of the subscriber to query.

  • auth_cookie (str) – An optional HTTP cookie for authorizing access.

Returns:

The path to the downloaded file.

Return type:

str