get_pot3d_quantity_properties

get_pot3d_quantity_properties(variable)

Return the Props descriptor for a POT3D quantity.

Parameters:

variablePot3dQuantities

Case-insensitive POT3D quantity name. Valid values: 'br', 'bt', 'bp'.

Returns:

outProps

Immutable descriptor for the requested POT3D magnetic field component.

Raises:

ValueError

If variable is not a recognized POT3D quantity.

Examples

>>> from psi_io.mhd_io import get_pot3d_quantity_properties
>>> get_pot3d_quantity_properties('bp').name
'bp'