get_mas_quantity_properties

get_mas_quantity_properties#

get_mas_quantity_properties(variable)[source]#

Return the Props descriptor for a MAS quantity.

Parameters:
variableMasQuantities

Case-insensitive MAS quantity name. Valid values: 'vr', 'vt', 'vp', 'br', 'bt', 'bp', 'jr', 'jt', 'jp', 't', 'te', 'tp', 'rho', 'p', 'ep', 'em', 'zp', 'zm', 'heat'.

Returns:
outProps

Immutable descriptor carrying the quantity name, description, astropy unit, and mesh stagger code.

Raises:
ValueError

If variable is not a recognized MAS quantity.

Examples

>>> from psi_io.mhd_io import get_mas_quantity_properties
>>> props = get_mas_quantity_properties('br')
>>> props.desc
'Magnetic Field (Radial Component)'
>>> get_mas_quantity_properties('BR').name   # case-insensitive
'br'
Contents