WIP: Add demonstrative examples to documentation #201
+286
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Benchmark Results (Julia v1.10)Time benchmarks
Memory benchmarks
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #201 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 191 191
=========================================
Hits 191 191 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| using Unitful | ||
| using Unitful.DefaultSymbols: mm, m | ||
|
|
||
|
|
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| struct Sector{L <: Unitful.Length, A} | ||
| r_inner::L | ||
| r_outer::L | ||
| ϕ_a::A |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| ϕ_a::A | |
| ϕ_a::A |
Comment on lines
+36
to
+37
| function _Ngon(sector::Sector; N=32) | ||
| ϕs = range(sector.ϕ_a, sector.ϕ_b, length=N) |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| function _Ngon(sector::Sector; N=32) | |
| ϕs = range(sector.ϕ_a, sector.ϕ_b, length=N) | |
| function _Ngon(sector::Sector; N = 32) | |
| ϕs = range(sector.ϕ_a, sector.ϕ_b, length = N) |
| return Meshes.Ngon(arc_o..., arc_i...) | ||
| end | ||
|
|
||
|
|
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
Comment on lines
+57
to
+59
| Δϕ = 2π/20 | ||
| ϕas = range(0, 2π - Δϕ, length=20) .- (Δϕ / 2) | ||
| ϕbs = range(0, 2π - Δϕ, length=20) .+ (Δϕ / 2) |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| Δϕ = 2π/20 | |
| ϕas = range(0, 2π - Δϕ, length=20) .- (Δϕ / 2) | |
| ϕbs = range(0, 2π - Δϕ, length=20) .+ (Δϕ / 2) | |
| Δϕ = 2π / 20 | |
| ϕas = range(0, 2π - Δϕ, length = 20) .- (Δϕ / 2) | |
| ϕbs = range(0, 2π - Δϕ, length = 20) .+ (Δϕ / 2) |
| # To Makie-compatible polygons | ||
| _poly(circle::Meshes.Circle; N=32) = [(_Point3f(circle(t)) for t in range(0, 1, length=N))...] | ||
| _poly(ngon::Meshes.Ngon) = [(_Point3f(pt) for pt in ngon.vertices)...] | ||
| _poly2d(circle::Meshes.Circle; N=32) = [(_Point2f(circle(t)) for t in range(0, 1, length=N))...] |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| _poly2d(circle::Meshes.Circle; N=32) = [(_Point2f(circle(t)) for t in range(0, 1, length=N))...] | |
| function _poly2d(circle::Meshes.Circle; N = 32) | |
| [(_Point2f(circle(t)) for t in range(0, 1, length = N))...] | |
| end |
| _poly2d(circle::Meshes.Circle; N=32) = [(_Point2f(circle(t)) for t in range(0, 1, length=N))...] | ||
| _poly2d(ngon::Meshes.Ngon) = [(_Point2f(pt) for pt in ngon.vertices)...] | ||
|
|
||
|
|
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
|
|
||
| # Illustrate the dartboard | ||
| fig = Figure() | ||
| ax = Axis(fig[1, 1], xlabel="y [m]", ylabel="z [m]") |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| ax = Axis(fig[1, 1], xlabel="y [m]", ylabel="z [m]") | |
| ax = Axis(fig[1, 1], xlabel = "y [m]", ylabel = "z [m]") |
Comment on lines
+100
to
+101
| poly!(ax, _poly2d(region.geometry), color=region.color) | ||
|
|
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| poly!(ax, _poly2d(region.geometry), color=region.color) | |
| poly!(ax, _poly2d(region.geometry), color = region.color) | |
| # Write score label on geometry | ||
| centerPt = centroid(region.geometry) | ||
| center = ustrip.(u"m", [centerPt.coords.y, centerPt.coords.z]) | ||
| text!(ax, string(region.points), position=Point2f(center...), align=(:center,:center), color=:blue, fontsize=10) |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| text!(ax, string(region.points), position=Point2f(center...), align=(:center,:center), color=:blue, fontsize=10) | |
| text!(ax, string(region.points), position = Point2f(center...), | |
| align = (:center, :center), color = :blue, fontsize = 10) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview: https://juliageometry.github.io/MeshIntegrals.jl/previews/PR201/