get_psi_scale_properties

get_psi_scale_properties#

get_psi_scale_properties(variable)[source]#

Return the Props 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:
outProps

Descriptor for the requested coordinate axis, carrying the appropriate astropy unit (PSI_rsun for 'r', PSI_angle for 't' and 'p').

Raises:
ValueError

If the first character of variable is not 'r', 't', or 'p'.

Examples

>>> from psi_io.mhd_io import get_psi_scale_properties
>>> get_psi_scale_properties('r').desc
'Radial Scale (Solar Radii)'
>>> get_psi_scale_properties('theta').name   # uses first character only
't'
Contents