get_psi_scale_properties

get_psi_scale_properties#

get_psi_scale_properties(variable)[source]#

Return the ScaleProps descriptor for a PSI coordinate scale.

Parameters:
variablePsiScales

Coordinate label. The first character is used for lookup, so 'r', 'radius', 't', 'theta', 'p', and 'phi' are all accepted.

Returns:
outScaleProps

Descriptor for the requested coordinate axis.

Raises:
ValueError

If variable is not a recognized PSI coordinate label.

See also

get_mas_quantity_properties

Analogous lookup for MAS model quantities.

get_pot3d_quantity_properties

Analogous lookup for POT3D model quantities.

Examples

>>> from psi_io.models import get_psi_scale_properties
>>> get_psi_scale_properties('r').desc
'PSI Radial Scale (Solar Radii)'
>>> get_psi_scale_properties('theta').name
't'
Contents