Users API

This reference covers the public runtime API used by scientific users and library integrators.

Core Construction

pyunitwizard.quantity(value[, unit, form, ...])	Returns a quantity.
pyunitwizard.unit(unit[, form, parser])	Returns a unit.

Core Conversion and Display

pyunitwizard.convert(quantity_or_unit[, ...])	Convert a quantity or unit across unit systems, forms, and output types.
pyunitwizard.to_string(quantity_or_unit[, ...])	Return a quantity or unit converted to string form.

Core Validation and Comparison

pyunitwizard.check(quantity_or_unit[, ...])	Check if a quantity or unit has the specified dimensionality, value_type, shape, unit or data type.
pyunitwizard.compatibility(...)	Check whether two quantities or units are dimensionally compatible.
pyunitwizard.are_compatible(...)	Check whether two quantities or units are compatible.
pyunitwizard.similarity(quantity_or_unit_1, ...)	Compare two quantities using relative tolerance semantics.
pyunitwizard.are_close(quantity_1, quantity_2)	Compares whether two quantities are similiar within a specified tolerance.
pyunitwizard.are_equal(quantity_or_unit_1, ...)	Compares whether two quantities are similiar within a specified tolerance.

Core Introspection and Extraction

pyunitwizard.get_form(quantity_or_unit)	Returns the form of a quantity as a string.
pyunitwizard.is_quantity(quantity_or_unit[, ...])	Check whether an object is a quantity
pyunitwizard.is_unit(quantity_or_unit[, parser])	Check whether an object is a unit
pyunitwizard.get_dimensionality(quantity_or_unit)	Return dimensional exponents for a quantity or unit.
pyunitwizard.is_dimensionless(quantity_or_unit)	Check wheter a quantity or unit is dimensionless.
pyunitwizard.get_value(quantity[, to_unit, ...])	Returns the value of a quantity.
pyunitwizard.get_unit(quantity[, to_form, ...])	Returns the unit of a quantity.
pyunitwizard.get_value_and_unit(quantity[, ...])	Returns the value and unit of a quantity.
pyunitwizard.change_value(quantity, value)	Return a quantity with a replaced value while preserving unit and form.

Standardization and Context

pyunitwizard.get_standard_units([...])	Returns standard unit of the quantity or unit passed.
pyunitwizard.standardize(quantity_or_unit[, ...])	Concert a quantity or unit to standard units.
pyunitwizard.context([default_form, ...])	Context manager to temporarily change PyUnitWizard configuration.

Runtime Configuration

pyunitwizard.configure.reset()	Reset runtime configuration state to defaults.
pyunitwizard.configure.load_library(...)	Load one or more backend libraries into runtime configuration.
pyunitwizard.configure.get_libraries_loaded()	Return currently loaded backend libraries.
pyunitwizard.configure.get_libraries_supported()	Return backend libraries supported by this installation.
pyunitwizard.configure.get_parsers_loaded()	Return currently loaded parsers.
pyunitwizard.configure.get_parsers_supported()	Return parser backends supported by this installation.
pyunitwizard.configure.get_default_form()	Return the configured default form for quantities and units.
pyunitwizard.configure.set_default_form(form)	Set the default form for quantities and units.
pyunitwizard.configure.get_default_parser()	Return the configured default parser.
pyunitwizard.configure.set_default_parser(parser)	Set the default parser for string quantities.
pyunitwizard.configure.get_standard_units()	Return configured standard units mapped to dimensionality definitions.
pyunitwizard.configure.set_standard_units(...)	Configure project standard units used by standardization helpers.