figure saving should be an option

Author: DanielVandH

Project.toml

@@ -1,7 +1,7 @@
 name = "DelaunayTriangulation"
 uuid = "927a84f5-c5f4-47a5-9785-b46e178433df"
 authors = ["Daniel VandenHeuvel <[email protected]>"]
-version = "0.4.1"
+version = "0.4.2"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"

test/data_structures/convex_hull.jl

@@ -2,6 +2,8 @@ using ..DelaunayTriangulation
 const DT = DelaunayTriangulation
 using CairoMakie
 
+include("../test_setup.jl")
+
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
 
 ch = ConvexHull(rand(2, 500), [1, 2, 4, 5, 6, 10, 29, 45, 71, 1])
@@ -35,4 +37,4 @@ fig = Figure()
 ax = Axis(fig[1, 1])
 scatter!(ax, pts)
 lines!(ax, pts[ch.indices])
-save("$save_path/convex_hull_1.png", fig)
+SAVE_FIGURE && save("$save_path/convex_hull_1.png", fig)

test/operations/add_ghost_triangles.jl

@@ -2,6 +2,7 @@ using ..DelaunayTriangulation
 const DT = DelaunayTriangulation
 using CairoMakie
 
+include("../test_setup.jl")
 include("../helper_functions.jl")
 
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
@@ -52,4 +53,4 @@ ax = Axis(fig[1, 2])
 triplot!(ax, tri; show_ghost_edges=true, ghost_edge_extension_factor=2.0)
 xlims!(ax, -2, 22)
 ylims!(ax, -2, 22)
-save("$save_path/test_add_ghost_triangles.png", fig)
+SAVE_FIGURE && save("$save_path/test_add_ghost_triangles.png", fig)

test/operations/delete_triangle.jl

@@ -2,6 +2,7 @@ using ..DelaunayTriangulation
 const DT = DelaunayTriangulation
 using CairoMakie
 
+include("../test_setup.jl")
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
 
 include("../helper_functions.jl")
@@ -55,4 +56,4 @@ triplot!(ax, tri; show_ghost_edges=true, ghost_edge_extension_factor=2.0)
 xlims!(ax, -2, 22)
 ylims!(ax, -2, 22)
 
-save("$save_path/test_delete_triangles.png", fig)
+SAVE_FIGURE && save("$save_path/test_delete_triangles.png", fig)

test/plotting.jl

@@ -5,6 +5,7 @@ using DataStructures
 
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
 
+include("./test_setup.jl")
 include("./helper_functions.jl")
 
 x, y = complicated_geometry()
@@ -13,7 +14,7 @@ tri = generate_mesh(x, y, 0.1; convert_result=true, add_ghost_triangles=true)
 fig1 = Figure()
 ax = Axis(fig1[1, 1])
 triplot!(ax, tri)
-save("$save_path/test_figure_1.png", fig1)
+SAVE_FIGURE && save("$save_path/test_figure_1.png", fig1)
 
 fig2 = Figure()
 ax = Axis(fig2[1, 1])
@@ -23,7 +24,7 @@ triplot!(ax, tri;
          markersize=6)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_2.png", fig2)
+SAVE_FIGURE && save("$save_path/test_figure_2.png", fig2)
 
 fig3 = Figure()
 ax = Axis(fig3[1, 1])
@@ -36,7 +37,7 @@ triplot!(ax, tri;
          ghost_edge_color=:darkgreen)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_3.png", fig3)
+SAVE_FIGURE && save("$save_path/test_figure_3.png", fig3)
 
 fig4 = Figure()
 ax = Axis(fig4[1, 1])
@@ -49,7 +50,7 @@ triplot!(ax, tri;
          ghost_edge_color=:darkgreen)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_4.png", fig4)
+SAVE_FIGURE && save("$save_path/test_figure_4.png", fig4)
 
 fig5 = Figure()
 ax = Axis(fig5[1, 1])
@@ -65,7 +66,7 @@ triplot!(ax, tri;
          strokewidth=0.0)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_5.png", fig5)
+SAVE_FIGURE && save("$save_path/test_figure_5.png", fig5)
 
 pts = get_points(tri)
 T = get_triangles(tri)
@@ -84,7 +85,7 @@ triplot!(ax, pts, T, bn, get_convex_hull(tri);
          strokewidth=0.0)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_6.png", fig6)
+SAVE_FIGURE && save("$save_path/test_figure_6.png", fig6)
 
 fig7 = Figure()
 ax = Axis(fig7[1, 1])
@@ -104,4 +105,4 @@ triplot!(ax, pts, T, bn, get_convex_hull(tri);
          strokewidth=0.0)
 xlims!(ax, -0.4, 2.4)
 ylims!(ax, -0.4, 6.4)
-save("$save_path/test_figure_7.png", fig7)
+SAVE_FIGURE && save("$save_path/test_figure_7.png", fig7)

test/polygon_utils.jl

@@ -6,6 +6,7 @@ using CairoMakie
 
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
 
+include("./test_setup.jl")
 include("./helper_functions.jl")
 
 tri, label_map, index_map = simple_geometry()
@@ -392,4 +393,4 @@ lines!(ax, bn1, color=:red, linewidth=4)
 lines!(ax, bn2, color=:red, linewidth=4)
 lines!(ax, bn3, color=:red, linewidth=4)
 scatter!(ax, [x], [y], color=:blue, markersize=23)
-save("$save_path/pole_of_inaccessibility.png", fig)
+SAVE_FIGURE && save("$save_path/pole_of_inaccessibility.png", fig)

test/test_setup.jl

@@ -0,0 +1 @@
+const SAVE_FIGURE = false

test/triangulation/bowyer_watson.jl

@@ -5,6 +5,7 @@ using StableRNGs
 using CairoMakie
 using DataStructures
 
+include("../test_setup.jl")
 include("../helper_functions.jl")
 
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
@@ -108,7 +109,7 @@ end
         convex_hull_linewidth=7)
     xlims!(ax, -6, 12)
     ylims!(ax, -6, 12)
-    save("$save_path/test_bowyer_watson_1.png", fig)
+    SAVE_FIGURE && save("$save_path/test_bowyer_watson_1.png", fig)
     BI = DT.BoundaryIndex
     @test get_triangles(tri) == Set{NTuple{3,Int64}}(((3, 2, BI),
         (4, BI, 5),
@@ -133,7 +134,7 @@ end
         convex_hull_linewidth=7, convex_hull_linestyle=:solid)
     xlims!(ax, -5.0, 5.0)
     ylims!(ax, -5.0, 5.0)
-    save("$save_path/test_bowyer_watson_2.png", fig)
+    SAVE_FIGURE && save("$save_path/test_bowyer_watson_2.png", fig)
     validate_triangulation(tri)
 end
 
@@ -336,5 +337,5 @@ end
     pts = [a, b, c, d, e, f, g, h, i, j]
     tri = DT.triangulate_bowyer_watson(pts; delete_ghosts=false)
     fig, ax, sc, = triplot(tri)
-    save("$save_path/small_example.png", fig)
+    SAVE_FIGURE && save("$save_path/small_example.png", fig)
 end

test/triangulation/gmsh.jl

@@ -1,10 +1,12 @@
 using Test
 using LinearAlgebra
 using ..DelaunayTriangulation
-const DT = DelaunayTriangulation.DT
+const DT = DelaunayTriangulation
 using CairoMakie
 using DataStructures
 
+include("../test_setup.jl")
+
 include("../helper_functions.jl")
 
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
@@ -1055,7 +1057,7 @@ lines!(ax, nodes[:, boundary_nodes[4][4]]; color=:orange, linewidth=6)
 
 lines!(ax, nodes[:, boundary_nodes[5][1]]; color=:red, linewidth=6)
 
-save("$save_path/sparse_example_triangulation.png", fig)
+SAVE_FIGURE && save("$save_path/sparse_example_triangulation.png", fig)
 
 ## A square
 x = [0.0, 2.0, 2.0, 0.0, 0.0]
@@ -1082,7 +1084,7 @@ elements4, nodes4, boundary_nodes4 = generate_mesh(0.0, 2.0, 0.0, 2.0, 0.5;
 ax = Axis(fig[2, 2])
 mesh!(ax, nodes4, elements4')
 
-save("$save_path/square_triangulation.png", fig)
+SAVE_FIGURE && save("$save_path/square_triangulation.png", fig)
 
 @test elements1 == elements3
 @test nodes1 == nodes3
@@ -1596,7 +1598,7 @@ ax = Axis(fig[1, 2], xlabel=L"x", ylabel=L"y", width=300, height=300,
     title=L"(b):$ $  Coarse mesh", titlealign=:left)
 triplot!(ax, tri2)
 resize_to_layout!(fig)
-save("$save_path/gmsh_example_1.png", fig)
+SAVE_FIGURE && save("$save_path/gmsh_example_1.png", fig)
 
 ### Another specific example with multiple segments 
 # The first segment 
@@ -1633,7 +1635,7 @@ for (i, segment_index) in enumerate(values(bn_map))
     lines!(ax, get_points(tri)[:, bn_nodes], color=colors[i], linewidth=4)
 end
 resize_to_layout!(fig)
-save("$save_path/gmsh_example_2.png", fig)
+SAVE_FIGURE && save("$save_path/gmsh_example_2.png", fig)
 
 ### For the docs 
 x1 = [collect(LinRange(0, 2, 4)),
@@ -1670,4 +1672,4 @@ tri = generate_mesh(x, y, 0.2)
 fig, ax, sc = triplot(tri; show_ghost_edges=true, convex_hull_linestyle=:solid, convex_hull_linewidth=4)
 xlims!(ax, -0.5, 2.5)
 ylims!(ax, -0.5, 6.5)
-save("$save_path/gmsh_example_3.png", fig)
+SAVE_FIGURE && save("$save_path/gmsh_example_3.png", fig)

test/triangulation/rectangle.jl

@@ -2,6 +2,8 @@ using ..DelaunayTriangulation
 const DT = DelaunayTriangulation
 using CairoMakie
 
+include("../test_setup.jl")
+
 save_path = basename(pwd()) == "test" ? "figures" : "test/figures"
 
 a, b, c, d = 2.0, 10.0, -5.0, 7.5
@@ -15,7 +17,7 @@ lines!(ax, tri.points[:, tri.boundary_nodes[1]]; linewidth=4)
 lines!(ax, tri.points[:, tri.boundary_nodes[2]]; linewidth=4)
 lines!(ax, tri.points[:, tri.boundary_nodes[3]]; linewidth=4)
 lines!(ax, tri.points[:, tri.boundary_nodes[4]]; linewidth=4)
-save("$save_path/rectangular_triangulation_1.png", fig)
+SAVE_FIGURE && save("$save_path/rectangular_triangulation_1.png", fig)
 @test tri.boundary_nodes[1] == 1:20
 @test tri.boundary_nodes[2] == 20:20:200
 @test tri.boundary_nodes[3] == 200:-1:181
@@ -25,7 +27,7 @@ tri = DT.triangulate_rectangle(a, b, c, d, nx, ny; single_boundary=true)
 fig, ax, sc = triplot(tri; show_ghost_edges=true)
 xlims!(ax, a - 0.5, b + 0.5)
 ylims!(ax, c - 0.5, d + 0.5)
-save("$save_path/rectangular_triangulation_2.png", fig)
+SAVE_FIGURE && save("$save_path/rectangular_triangulation_2.png", fig)
 bn = reduce(vcat, [1:20, 20:20:200, 200:-1:181, 181:-20:1])
 unique!(bn)
 push!(bn, 1)