fetch_mas_quantities

fetch_mas_quantities(*, quantities='ch_pm', hdf=5)

Fetch derived MAS quantities defined at the model inner radial boundary.

Downloads MAS “quantities at \(r_0\)” files — scalar quantities evaluated at the inner radial boundary of the coronal domain — and returns their cached paths.

Parameters:

quantitiesstr | Iterable | None, optional

Quantity name(s) to fetch, e.g. "ch_pm". Accepts a comma-separated string, an iterable of quantity names, or None to fetch every available quantity. Default is "ch_pm".

hdfint, optional

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

Returns:

pathsFilepaths

Named tuple whose fields are the quantity names and whose values are the Path of each downloaded file.

Raises:

ValueError

If hdf is not a supported HDF version.

See also

fetch_mas_data

Fetch full MAS MHD field output.

Examples

>>> from psi_data import fetch_mas_quantities
>>> paths = fetch_mas_quantities(quantities="ch_pm")
>>> paths.ch_pm
PosixPath('.../cor/quantities_at_r0/ch_pm.h5')