fetch_example_fieldline

fetch_example_fieldline#

fetch_example_fieldline(*, hdf=5)#

Fetch the bundled example magnetic field line trace data file.

Parameters:
hdfint, optional

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

Returns:
pathPath

Cached path of the downloaded field line example file.

Raises:
ValueError

If hdf is not a supported HDF version.

See also

fetch_example_radial_scale

Fetch the example radial scaling data file.

fetch_example_chmapdb

Fetch the example coronal-hole map database.

Examples

>>> from psi_data import fetch_example_fieldline
>>> path = fetch_example_fieldline()
>>> path.name
'fieldline.h5'
Contents