get_fieldline_data

get_fieldline_data#

get_fieldline_data(hdf='.h5')[source]#

Fetch the magnetic fieldline (2D) data file.

Warning

Unlike the other example data files, fieldline data files do not contain scale datasets.

Parameters:
hdfHdfExtType, optional

The HDF file format to fetch. Accepted values are '.h5' for HDF5 and '.hdf' for HDF4. Default is '.h5'.

Returns:
outstr

Local path to the downloaded (and cached) magnetic fieldline data file.

Examples

>>> from psi_io import data
>>> path = data.get_fieldline_data()
>>> path.endswith(".h5")
True