get_quantity

function of dascore.units

source

get_quantity(
    value: str | bytes | pint.registry.Quantity | pint.facets.plain.unit.PlainUnit | numpy.datetime64 | numpy.timedelta64 | int | float | ellipsis | None[str, <class ’bytes, Quantity, PlainUnit, datetime64, timedelta64, int, float, <class ’ellipsis, None] ,
)-> ‘Quantity | None’

Convert a value to a pint quantity.

Returns None for None, Ellipsis, or an empty string (no units). Handle this before using the result in arithmetic.

Parameters

Parameter	Description
value	The value to convert to a quantity.

Examples

import dascore as dc
meters = dc.get_quantity("m")
accel = dc.get_quantity("m/s^2")

# This can also convert date times.
many_seconds = dc.get_quantity(dc.to_timedelta64(200))