How-to guides

How-to guides#

Directions for getting a specific job done. These pages assume you already know what you want and are looking for the shortest route to it.

If you are new to unxt, work through Your first calculation with units first — these guides will not teach you the basics.

How to convert between units — uconvert, ustrip and uconvert_value.
How to compare quantities — is_unit_convertible, equivalent and ==.
How to wrap angles to a range — map an angle onto a branch cut.
How to pass a quantity as a jax.jit static argument — StaticQuantity and StaticValue under jax.jit.
How to use JAX functions with quantities — quaxify, quaxed, jit, autodiff and functional updates.
How to control how quantities are displayed — change how quantities render, for a call, a block, a process or a project.

How to define a unit system — write your own AbstractUnitSystem subclass.
How to build a unit system where G = 1 — a system where \(G = 1\), for dynamics codes.
How to work in natural units — worked examples in HEP, geometrized, atomic and Planck units.

How to check quantity types at runtime — enforce dtype and shape annotations at runtime.
How to optimize performance with unitful quantities — keep wrapper overhead off your hot path.
How to teach JAX a new primitive rule — teach JAX a primitive rule of your own.
How to interoperate with astropy — move values between astropy and unxt safely.