saiunit.compatible_with_equinox

saiunit.compatible_with_equinox#

saiunit.compatible_with_equinox(mode=True)[source]#

Enable or disable compatibility with the Equinox library.

When enabled, Quantity objects interact correctly with Equinox transformations such as those used in unit-aware diffrax.

Parameters:

mode (bool) – If True (default), enable Equinox compatibility. If False, disable it.

Examples

>>> import saiunit as u
>>> u.compatible_with_equinox(True)   # enable
>>> u.compatible_with_equinox(False)  # disable

See also

Quantity

The core physical-quantity class affected by this setting.