Basic Makie.jl support

[icweaver]

Closes #164

Demo

using DynamicQuantities, GLMakie

fig = Figure()

y = 60:10:100

scatter(fig[1, 1], y * u"m")
scatter(fig[1, 2], QuantityArray(y, u"m"))
scatter(fig[2, 1], y * u"kg", y * u"m")
scatter(fig[2, 2], y * us"m/s/Hz")

fig

See docs for more examples using Makie's dimension conversion machinery

TODO

• Unit tests, see, e.g., unitful reftests, test/conversions/dim-converts.jl
• Documentation

Future PR(s)?

• Affine units?
• Heatmap and Image support. Maybe with a recipe
• Rich strings (Unitful example)

[github-actions]

Benchmark Results

	main	2893c01...	main / 2893c01...
Quantity/creation/Quantity(x)	2.79 ± 0.001 ns	3.11 ± 0.059 ns	0.9
Quantity/creation/Quantity(x, length=y)	3.43 ± 0.01 ns	3.73 ± 0.01 ns	0.919
Quantity/with_numbers/*real	3.41 ± 0.01 ns	2.79 ± 0.001 ns	1.22
Quantity/with_numbers/^int	8.69 ± 1.6 ns	8.37 ± 1.6 ns	1.04
Quantity/with_numbers/^int * real	8.98 ± 1.6 ns	8.99 ± 1.6 ns	0.999
Quantity/with_quantity/+y	4.04 ± 0.01 ns	4.35 ± 0.001 ns	0.929
Quantity/with_quantity//y	3.11 ± 0.001 ns	3.42 ± 0.011 ns	0.909
Quantity/with_self/dimension	3.1 ± 0.01 ns	3.11 ± 0.01 ns	1
Quantity/with_self/inv	3.41 ± 0.01 ns	3.11 ± 0.001 ns	1.1
Quantity/with_self/ustrip	2.79 ± 0.01 ns	3.1 ± 0.01 ns	0.9
QuantityArray/broadcasting/multi_array_of_quantities	0.0875 ± 0.0012 ms	0.0875 ± 0.0013 ms	1
QuantityArray/broadcasting/multi_normal_array	0.0497 ± 0.0017 ms	0.0496 ± 0.0023 ms	1
QuantityArray/broadcasting/multi_quantity_array	0.0561 ± 0.00044 ms	0.059 ± 0.0062 ms	0.95
QuantityArray/broadcasting/x^2_array_of_quantities	14.6 ± 3.1 μs	14.7 ± 2.9 μs	0.99
QuantityArray/broadcasting/x^2_normal_array	2.31 ± 1.1 μs	2.43 ± 2.6 μs	0.951
QuantityArray/broadcasting/x^2_quantity_array	6.49 ± 0.14 μs	3.54 ± 0.39 μs	1.84
QuantityArray/broadcasting/x^4_array_of_quantities	0.0842 ± 0.001 ms	0.0813 ± 0.0014 ms	1.04
QuantityArray/broadcasting/x^4_normal_array	0.0497 ± 0.002 ms	0.0496 ± 0.00031 ms	1
QuantityArray/broadcasting/x^4_quantity_array	0.0498 ± 0.0031 ms	0.0467 ± 0.00037 ms	1.07
time_to_load	0.199 ± 0.0018 s	0.201 ± 0.0013 s	0.99

Benchmark Plots

A plot of the benchmark results have been uploaded as an artifact to the workflow run for this PR.
Go to "Actions"->"Benchmark a pull request"->[the most recent run]->"Artifacts" (at the bottom).

[icweaver]

Just saw this really cool update from Julius on the AoG side of things!

MakieOrg/AlgebraOfGraphics.jl#619

https://aog.makie.org/v0.9.6/examples/scales/units#units

This also looks to address MakieOrg/Makie.jl#3890 in one fell swoop

[MilesCranmer]

Cool!

Let me know (by tagging me) when you're ready for review

[icweaver]

Hi @MilesCranmer, I think this should be just about ready for a first pass of reviews now.

The main additions are:

• A DynamicQuantitiesMakieExt.DQConversion struct to provide similar functionality to Makie's UnitfulConversion until it can be potentially upstreamed
• A units example in the docs based on DynamicQuantities.jl > Toy Examples with Code > 2. Projectile motion

I'm not quite sure yet how I feel about Makie's choice to automatically change non-compound units for folks out from under them, so I kept that bit of machinery out for now. I do see the convenience of it though, it just seems to add a fair bit of complexity that we maybe don't need right now. Instead, this current design favors explicit over implicit unit handling, e.g.,

Unitful example (taken from ReferenceTests)

# Don't swallow units past the first
f, a, p = scatter((1:10) .* u"J/s")
# Don't simplify (assume the user knows better)
scatter(f[1, 2], (1:10) .* u"K", exp.(1:10) .* u"mm/m^2")
# Only change prefixes of simple units, not compound units
scatter(f[2, 1], 10 .^ (1:6) .* u"W/m^2", (1:6) .* 1000 .* u"nm")
# Only change units/prefixes for simple units when adding more plots
scatter(f[2, 2], (0:10) .* u"W/m^2", (0:10) .* u"g")
scatter!((0:10) .* u"kW/m^2", (0:10) .* u"kg")
f

Here the nanometer plot in the bottom left is auto-converted to microns without the user specifying that unit. In contrast:

This PR

using DynamicQuantities, Makie
const DQConversion = Base.get_extension(DynamicQuantities, :DynamicQuantitiesMakieExt).DQConversion

fig = Figure()

ax1 = Axis(fig[1, 1]; dim2_conversion=DQConversion(us"J/s"))
ax2 = Axis(fig[1, 2]; dim2_conversion=DQConversion(us"mm/m^2"))
ax3 = Axis(fig[2, 1]; dim1_conversion=DQConversion(us"W/m^2"), dim2_conversion=DQConversion(us"μm"))
ax4 = Axis(fig[2, 2]; dim1_conversion=DQConversion(us"W/m^2"))

scatter!(ax1, (1:10) .* u"J/s")
scatter!(ax2, (1:10) .* u"K", exp.(1:10) .* u"mm/m^2")
scatter!(ax3, 10 .^ (1:6) .* u"W/m^2", (1:6) .* 1000 .* u"nm")
scatter!(ax4, (0:10) .* u"W/m^2", (0:10) .* u"g")
scatter!(ax4, (0:10) .* u"kW/m^2", (0:10) .* u"kg")

fig

or with the appropriate use of SymbolicDimensions:

fig = Figure()

scatter(fig[1, 1], (1:10) .* us"J/s")
scatter(fig[1, 2], (1:10) .* u"K", exp.(1:10) .* us"mm/m^2")
scatter(fig[2, 1], 10 .^ (1:6) .* us"W/m^2", (1:6) .* 1000 .* u"nm"; axis=(; dim2_conversion=DQConversion(us"μm")))
scatter(fig[2, 2], (0:10) .* u"W/m^2", (0:10) .* u"g"; axis=(; dim1_conversion=DQConversion(us"W/m^2")))
scatter!(fig[2, 2], (0:10) .* u"kW/m^2", (0:10) .* us"kg")

fig

Happy to save that kind of discussion for a separate PR though if it's starting to get too in the weeds for this basic functionality PR. Thanks again for taking a look!