lair.inventories.Inventory.get_units#

Inventory.get_units(pint=False)[source]#

Get the quantity, area, and time units of the inventory data.

Parameters:

pint (bool, optional) – Whether to return pint units, by default False.

Returns:

tuple[Any, Any, Any] – The quantity, area, and time units.

Raises:

ValueError – If the sectors are in different units, which have no single quantity, area and time unit.

Return type:

tuple[Any, Any, Any]

See also

Inventory.convert_units

Converts the data to other units.

Examples

For EDGAR (kg m-2 s-1):

inv.get_units()  # ('kg', 'm**2', 's')
inv.get_units(pint=True)  # quantities of 1 kg, 1 m**2 and 1 s