fetch_example_radial_scale

fetch_example_radial_scale#

fetch_example_radial_scale(*, hdf=5)#

Fetch the bundled example radial scaling 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 radial scaling example file.

Raises:
ValueError

If hdf is not a supported HDF version.

See also

fetch_example_fieldline

Fetch the example field line data file.

Notes

The radial scaling profile is commonly used to rescale MHD variables that fall off steeply with heliocentric radius \(r\), improving the dynamic range of visualizations.

Examples

>>> from psi_data import fetch_example_radial_scale
>>> path = fetch_example_radial_scale()
>>> path.name
'rscale.h5'
Contents