brainunit.get_dim_for_display

brainunit.get_dim_for_display(d)

Return a string representation of a dimension for display purposes.

Parameters:

d (Dimension or int) – The dimension to display. An integer value of 1 is treated as dimensionless.

Returns:

s – A string such as 'm kg s^-2' or '1' for dimensionless.

Return type:

str

See also

Dimension

The Dimension class.

Examples

>>> import saiunit as u
>>> u.get_dim_for_display(u.DIMENSIONLESS)
'1'
>>> u.get_dim_for_display(u.meter.dim)
'm'