fetch_all

Contents

fetch_all#

fetch_all(*, hdf=5)#

Fetch every registry file matching the requested HDF version.

Downloads all files in the fetcher registry whose names end with the extension for the requested HDF version and returns their cached paths.

Parameters:
hdfint, optional

HDF format version to download: 4 (.hdf) or 5 (.h5). Default is 5.

Returns:
filepathslist[Path]

Cached paths of every downloaded file, in registry order.

Raises:
ValueError

If hdf is not a supported HDF version.

See also

fetch_mas_data

Fetch a targeted subset of MAS field output.

Notes

This downloads the entire data collection for the chosen format and may transfer a large volume of data on its first invocation.

Examples

>>> from psi_data import fetch_all
>>> paths = fetch_all(hdf=5)
>>> all(p.suffix == ".h5" for p in paths)
True