jaxoplanet.test_utils#

Module Contents#

Functions#

assert_allclose(calculated, expected, *args, **kwargs)

Check that two floating point arrays are equal within a dtype-dependent tolerance

assert_quantity_allclose(calculated, expected, *args)

Check that two floating point quantities are equal within a dtype-dependent tolerance

assert_quantity_pytree_allclose(calculated, expected, ...)

Check that two Pytrees with floating point quantities or arrays as leaves are equal

jaxoplanet.test_utils.assert_allclose(calculated, expected, *args, **kwargs)[source]#

Check that two floating point arrays are equal within a dtype-dependent tolerance

jaxoplanet.test_utils.assert_quantity_allclose(calculated, expected, *args, convert=False, **kwargs)[source]#

Check that two floating point quantities are equal within a dtype-dependent tolerance

By default, the units are required to also be equal, but a conversion will be attempted if the convert argument is set to True.

jaxoplanet.test_utils.assert_quantity_pytree_allclose(calculated, expected, *args, is_leaf=is_quantity, **kwargs)[source]#

Check that two Pytrees with floating point quantities or arrays as leaves are equal within a dtype-dependent tolerance