fetch_example_chmapdb

fetch_example_chmapdb#

fetch_example_chmapdb(*, hdf=5)#

Fetch the bundled example coronal-hole map database, if available.

Parameters:
hdfint, optional

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

Returns:
pathPath | None

Cached path of the downloaded coronal-hole map database, or None if the file is unavailable for the requested HDF version.

Raises:
ValueError

If hdf is not a supported HDF version.

Warns:
RegistryWarning

If the database is not available for the requested HDF version (it is currently provided only for HDF5).

See also

fetch_example_fieldline

Fetch the example field line data file.

Examples

>>> from psi_data import fetch_example_chmapdb
>>> path = fetch_example_chmapdb(hdf=5)
>>> path.name
'chmap.h5'
Contents