UnitfulLatexify

Deprecation

This package has been replaced by a (nearly-identical) extension directly in Unitful, so instead of installing this package, simply use

julia> using Unitful, Latexify

and all of this functionality will already be available. If you are updating code that used UnitfulLatexify, there are a few breaking changes to be aware of:

• The unitformat keyword argument to latexify is replaced by the fmt keyword argument, which can be set to FancyNumberFormatter(), SiunitxNumberFormatter()., or StyledNumberFormatter().
• The siunitxlegacy keyword argument is replaced by the version keyword argument of SiunitxNumberFormatter(), where 2 is legacy and 3 is current.
• The functions latexslashunitlabel, latexroundunitlabel, latexsquareunitlabel, and latexfracunitlabel no longer exist, and should be replaced as either:
  • First call Latexify.set_default(labelformat=:slash), then use latexify directly
  • Direct substitute: (l,u) -> latexify(l, u; labelformat=:slash) with :slash, :round, :square, or :frac

Archive

Adds Latexify recipes for Unitful units and quantities.

Installation

] add UnitfulLatexify

Usage

julia> using Unitful, Latexify, UnitfulLatexify;
julia> q = 612.2u"nm";
julia> u = u"kg*m/s^2";
julia> latexify(q)
L"\$612.2\;\mathrm{nm}$"

$$612.2 \mathrm{nm}$$

julia> latexify(u; unitformat=:mathrm) # explicit default
L"$\mathrm{kg}\,\mathrm{m}\,\mathrm{s}^{-2}$"

$$\mathrm{kg} \mathrm{m} \mathrm{s}^{-2}$$

julia> latexify(q; unitformat=:siunitx)
L"\qty{612.2}{\nano\meter}"

julia> latexify(u,unitformat=:siunitx)
L"\unit{\kilo\gram\meter\per\second\tothe{2}}"

One use case is in Pluto notebooks, where my current favourite workflow is to write

Markdown.parse("""
The period is $(@latexrun T = $(2.5u"ms")), so the frequency is $(@latexdefine f = 1/T post=u"kHz").
""")

, which renders as

The period is $T = 2.5 \mathrm{ms}$, so the frequency is $f = \frac{1}{T} = 0.4 \mathrm{kHz}$.

Note that the quantity has to be interpolated (put inside a dollar-parenthesis), or Latexify will interpret it as a multiplication between a number and a call to @u_str.

More examples