Skip to content

[docs] Makie.jl #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[docs] Makie.jl #183

wants to merge 2 commits into from

Conversation

icweaver
Copy link
Contributor

@icweaver icweaver commented Aug 6, 2025

Documents plotting capabilities with Makie.jl

Depends on: MakieOrg/Makie.jl#5137

Based on: #165

@icweaver icweaver mentioned this pull request Aug 6, 2025
2 tasks
Copy link
Contributor

github-actions bot commented Aug 6, 2025

Benchmark Results (Julia v1.10)

Time benchmarks
main 6fa5e10... main / 6fa5e10...
Quantity/creation/Quantity(x) 3.42 ± 0.01 ns 3.11 ± 0.01 ns 1.1 ± 0.0048
Quantity/creation/Quantity(x, length=y) 3.11 ± 0.01 ns 3.11 ± 0.01 ns 1 ± 0.0046
Quantity/with_numbers/*real 3.1 ± 0.01 ns 3.11 ± 0.001 ns 1 ± 0.0032
Quantity/with_numbers/^int 8.05 ± 2.2 ns 8.67 ± 2.5 ns 0.929 ± 0.36
Quantity/with_numbers/^int * real 8.67 ± 2.5 ns 8.37 ± 2.2 ns 1.04 ± 0.4
Quantity/with_quantity/+y 4.04 ± 0.01 ns 4.04 ± 0.001 ns 1 ± 0.0025
Quantity/with_quantity//y 3.42 ± 0.011 ns 3.42 ± 0.011 ns 1 ± 0.0046
Quantity/with_self/dimension 3.1 ± 0.01 ns 3.1 ± 0.01 ns 1 ± 0.0046
Quantity/with_self/inv 3.11 ± 0.01 ns 3.41 ± 0.01 ns 0.912 ± 0.004
Quantity/with_self/ustrip 2.79 ± 0.01 ns 3.1 ± 0.01 ns 0.9 ± 0.0043
QuantityArray/broadcasting/multi_array_of_quantities 0.142 ± 0.0014 ms 0.144 ± 0.0021 ms 0.988 ± 0.017
QuantityArray/broadcasting/multi_normal_array 0.0557 ± 0.0031 ms 0.0559 ± 0.0031 ms 0.998 ± 0.078
QuantityArray/broadcasting/multi_quantity_array 0.156 ± 0.0011 ms 0.168 ± 0.0014 ms 0.924 ± 0.01
QuantityArray/broadcasting/x^2_array_of_quantities 28.8 ± 3 μs 26.3 ± 2.3 μs 1.1 ± 0.15
QuantityArray/broadcasting/x^2_normal_array 6.26 ± 0.73 μs 6.02 ± 0.65 μs 1.04 ± 0.17
QuantityArray/broadcasting/x^2_quantity_array 7.17 ± 0.49 μs 7.14 ± 0.43 μs 1 ± 0.092
QuantityArray/broadcasting/x^4_array_of_quantities 0.0819 ± 0.00091 ms 0.0818 ± 0.00099 ms 1 ± 0.016
QuantityArray/broadcasting/x^4_normal_array 0.0499 ± 0.00022 ms 0.0499 ± 0.00019 ms 1 ± 0.0059
QuantityArray/broadcasting/x^4_quantity_array 0.053 ± 0.003 ms 0.0501 ± 0.00022 ms 1.06 ± 0.06
time_to_load 0.193 ± 0.0029 s 0.195 ± 0.0022 s 0.99 ± 0.018
Memory benchmarks
main 6fa5e10... main / 6fa5e10...
Quantity/creation/Quantity(x) 0 allocs: 0 B 0 allocs: 0 B
Quantity/creation/Quantity(x, length=y) 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/*real 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/^int 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/^int * real 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_quantity/+y 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_quantity//y 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/dimension 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/inv 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/ustrip 0 allocs: 0 B 0 allocs: 0 B
QuantityArray/broadcasting/multi_array_of_quantities 2 allocs: 0.382 MB 2 allocs: 0.382 MB 1
QuantityArray/broadcasting/multi_normal_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
QuantityArray/broadcasting/multi_quantity_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
QuantityArray/broadcasting/x^2_array_of_quantities 2 allocs: 0.382 MB 2 allocs: 0.382 MB 1
QuantityArray/broadcasting/x^2_normal_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
QuantityArray/broadcasting/x^2_quantity_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
QuantityArray/broadcasting/x^4_array_of_quantities 2 allocs: 0.382 MB 2 allocs: 0.382 MB 1
QuantityArray/broadcasting/x^4_normal_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
QuantityArray/broadcasting/x^4_quantity_array 2 allocs: 0.0763 MB 2 allocs: 0.0763 MB 1
time_to_load 0.153 k allocs: 14.5 kB 0.153 k allocs: 14.5 kB 1

Copy link
Contributor

github-actions bot commented Aug 6, 2025

Benchmark Results (Julia v1)

Time benchmarks
main 6fa5e10... main / 6fa5e10...
Quantity/creation/Quantity(x) 3.1 ± 0.01 ns 3.1 ± 0.01 ns 1 ± 0.0046
Quantity/creation/Quantity(x, length=y) 3.8 ± 0.61 ns 3.73 ± 0.01 ns 1.02 ± 0.16
Quantity/with_numbers/*real 2.79 ± 0.001 ns 2.79 ± 0.001 ns 1 ± 0.00051
Quantity/with_numbers/^int 8.68 ± 2.2 ns 8.68 ± 2.2 ns 1 ± 0.35
Quantity/with_numbers/^int * real 9.29 ± 2.2 ns 9.29 ± 2.2 ns 1 ± 0.33
Quantity/with_quantity/+y 4.35 ± 0.01 ns 4.35 ± 0.009 ns 1 ± 0.0031
Quantity/with_quantity//y 3.42 ± 0.01 ns 3.41 ± 0.01 ns 1 ± 0.0042
Quantity/with_self/dimension 3.1 ± 0.01 ns 3.11 ± 0.01 ns 1 ± 0.0046
Quantity/with_self/inv 4.03 ± 0.01 ns 3.11 ± 0.001 ns 1.3 ± 0.0032
Quantity/with_self/ustrip 3.1 ± 0.01 ns 3.1 ± 0.01 ns 1 ± 0.0046
QuantityArray/broadcasting/multi_array_of_quantities 0.0908 ± 0.0011 ms 0.0905 ± 0.0043 ms 1 ± 0.05
QuantityArray/broadcasting/multi_normal_array 0.0498 ± 0.00025 ms 0.0498 ± 0.00023 ms 1 ± 0.0069
QuantityArray/broadcasting/multi_quantity_array 0.0622 ± 0.0093 ms 0.0623 ± 0.00021 ms 0.998 ± 0.15
QuantityArray/broadcasting/x^2_array_of_quantities 14.3 ± 2.1 μs 13.4 ± 2.7 μs 1.07 ± 0.27
QuantityArray/broadcasting/x^2_normal_array 2.5 ± 2.5 μs 2.39 ± 1.6 μs 1.04 ± 1.2
QuantityArray/broadcasting/x^2_quantity_array 3.58 ± 0.37 μs 6.56 ± 0.24 μs 0.545 ± 0.06
QuantityArray/broadcasting/x^4_array_of_quantities 0.0843 ± 0.00074 ms 0.0842 ± 0.00076 ms 1 ± 0.013
QuantityArray/broadcasting/x^4_normal_array 0.0497 ± 0.00021 ms 0.0497 ± 0.00016 ms 1 ± 0.0053
QuantityArray/broadcasting/x^4_quantity_array 0.0468 ± 0.0008 ms 0.0468 ± 0.00018 ms 1 ± 0.018
time_to_load 0.203 ± 0.001 s 0.202 ± 0.0011 s 1 ± 0.0075
Memory benchmarks
main 6fa5e10... main / 6fa5e10...
Quantity/creation/Quantity(x) 0 allocs: 0 B 0 allocs: 0 B
Quantity/creation/Quantity(x, length=y) 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/*real 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/^int 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_numbers/^int * real 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_quantity/+y 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_quantity//y 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/dimension 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/inv 0 allocs: 0 B 0 allocs: 0 B
Quantity/with_self/ustrip 0 allocs: 0 B 0 allocs: 0 B
QuantityArray/broadcasting/multi_array_of_quantities 3 allocs: 0.382 MB 3 allocs: 0.382 MB 1
QuantityArray/broadcasting/multi_normal_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
QuantityArray/broadcasting/multi_quantity_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
QuantityArray/broadcasting/x^2_array_of_quantities 3 allocs: 0.382 MB 3 allocs: 0.382 MB 1
QuantityArray/broadcasting/x^2_normal_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
QuantityArray/broadcasting/x^2_quantity_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
QuantityArray/broadcasting/x^4_array_of_quantities 3 allocs: 0.382 MB 3 allocs: 0.382 MB 1
QuantityArray/broadcasting/x^4_normal_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
QuantityArray/broadcasting/x^4_quantity_array 3 allocs: 0.0764 MB 3 allocs: 0.0764 MB 1
time_to_load 0.159 k allocs: 11.2 kB 0.159 k allocs: 11.2 kB 1

Copy link

codecov bot commented Aug 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.21%. Comparing base (725e48d) to head (6fa5e10).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #183   +/-   ##
=======================================
  Coverage   99.21%   99.21%           
=======================================
  Files          21       21           
  Lines        1273     1273           
=======================================
  Hits         1263     1263           
  Misses         10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

# Can explicitly import units:
using DynamicQuantities: km, m, s, min

y0 = 10km
v0 = 250m/s
θ = deg2rad(60)
g = 9.81m/s^2
nothing # hide
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use ; instead of a new line with this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right, it got buried in the previous PR, but I think I was running into this when trying to do that. It's been a while though, so I'll go back and try it again

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, yea, still looks like no dice with @example blocks + semicolon suppression:

```@example projectile
# Can explicitly import units:
using DynamicQuantities: km, m, s, min

y0 = 10km
v0 = 250m/s
θ = deg2rad(60)
g = 9.81m/s^2;
```
image

It looks like this may be a design decision

On the flip side, we could use a @repl block if you like and output all the things equally:

```@repl projectile
# Can explicitly import units:
using DynamicQuantities: km, m, s, min

y0 = 10km
v0 = 250m/s
θ = deg2rad(60)
g = 9.81m/s^2
```
image

For completeness, the semicolon also works here, but it's probably not what we want in this case:

```@repl projectile
# Can explicitly import units:
using DynamicQuantities: km, m, s, min

y0 = 10km
v0 = 250m/s
θ = deg2rad(60)
g = 9.81m/s^2;
```
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants