Skip to content

Commit a8ab8fa

Browse files
sjkellysjkelly
committed
update docs
1 parent 0564487 commit a8ab8fa

File tree

5 files changed

+203
-45
lines changed

5 files changed

+203
-45
lines changed

‎Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "Meshing"
22
uuid = "e6723b4c-ebff-59f1-b4b7-d97aa5274f73"
3-
version = "0.7.0"
3+
version = "0.6.0"
44

55
[deps]
66

‎docs/Manifest.toml

Lines changed: 196 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,195 @@
11
# This file is machine-generated - editing it directly is not advised
22

3+
[[ANSIColoredPrinters]]
4+
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
5+
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
6+
version = "0.0.1"
7+
8+
[[AbstractTrees]]
9+
git-tree-sha1 = "2d9c9a55f9c93e8887ad391fbae72f8ef55e1177"
10+
uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
11+
version = "0.4.5"
12+
13+
[[ArgTools]]
14+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
15+
version = "1.1.1"
16+
17+
[[Artifacts]]
18+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
19+
320
[[Base64]]
421
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
522

23+
[[CodecZlib]]
24+
deps = ["TranscodingStreams", "Zlib_jll"]
25+
git-tree-sha1 = "b8fe8546d52ca154ac556809e10c75e6e7430ac8"
26+
uuid = "944b1d66-785c-5afd-91f1-9de20f533193"
27+
version = "0.7.5"
28+
629
[[Dates]]
730
deps = ["Printf"]
831
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
932

1033
[[DocStringExtensions]]
1134
deps = ["LibGit2"]
12-
git-tree-sha1 = "a32185f5428d3986f47c2ab78b1f216d5e6cc96f"
35+
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
1336
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
14-
version = "0.8.5"
37+
version = "0.9.3"
1538

1639
[[Documenter]]
17-
deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
18-
git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c"
40+
deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "CodecZlib", "Dates", "DocStringExtensions", "Downloads", "Git", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "TOML", "Test", "Unicode"]
41+
git-tree-sha1 = "76deb8c15f37a3853f13ea2226b8f2577652de05"
1942
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
20-
version = "0.23.4"
43+
version = "1.5.0"
44+
45+
[[Downloads]]
46+
deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"]
47+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
48+
version = "1.6.0"
49+
50+
[[Expat_jll]]
51+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
52+
git-tree-sha1 = "1c6317308b9dc757616f0b5cb379db10494443a7"
53+
uuid = "2e619515-83b5-522b-bb60-26c02a35a201"
54+
version = "2.6.2+0"
55+
56+
[[FileWatching]]
57+
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
58+
59+
[[Git]]
60+
deps = ["Git_jll"]
61+
git-tree-sha1 = "04eff47b1354d702c3a85e8ab23d539bb7d5957e"
62+
uuid = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2"
63+
version = "1.3.1"
64+
65+
[[Git_jll]]
66+
deps = ["Artifacts", "Expat_jll", "JLLWrappers", "LibCURL_jll", "Libdl", "Libiconv_jll", "OpenSSL_jll", "PCRE2_jll", "Zlib_jll"]
67+
git-tree-sha1 = "d18fb8a1f3609361ebda9bf029b60fd0f120c809"
68+
uuid = "f8c6e375-362e-5223-8a59-34ff63f689eb"
69+
version = "2.44.0+2"
70+
71+
[[IOCapture]]
72+
deps = ["Logging", "Random"]
73+
git-tree-sha1 = "b6d6bfdd7ce25b0f9b2f6b3dd56b2673a66c8770"
74+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
75+
version = "0.2.5"
2176

2277
[[InteractiveUtils]]
2378
deps = ["Markdown"]
2479
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
2580

81+
[[JLLWrappers]]
82+
deps = ["Artifacts", "Preferences"]
83+
git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca"
84+
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
85+
version = "1.5.0"
86+
2687
[[JSON]]
2788
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
28-
git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
89+
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
2990
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
30-
version = "0.21.2"
91+
version = "0.21.4"
92+
93+
[[LazilyInitializedFields]]
94+
git-tree-sha1 = "8f7f3cabab0fd1800699663533b6d5cb3fc0e612"
95+
uuid = "0e77f7df-68c5-4e49-93ce-4cd80f5598bf"
96+
version = "1.2.2"
97+
98+
[[LibCURL]]
99+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
100+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
101+
version = "0.6.4"
102+
103+
[[LibCURL_jll]]
104+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
105+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
106+
version = "8.4.0+0"
31107

32108
[[LibGit2]]
33-
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
109+
deps = ["Base64", "LibGit2_jll", "NetworkOptions", "Printf", "SHA"]
34110
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
35111

112+
[[LibGit2_jll]]
113+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll"]
114+
uuid = "e37daf67-58a4-590a-8e99-b0245dd2ffc5"
115+
version = "1.6.4+0"
116+
117+
[[LibSSH2_jll]]
118+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
119+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
120+
version = "1.11.0+1"
121+
122+
[[Libdl]]
123+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
124+
125+
[[Libiconv_jll]]
126+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
127+
git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175"
128+
uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531"
129+
version = "1.17.0+0"
130+
36131
[[Logging]]
37132
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
38133

39134
[[Markdown]]
40135
deps = ["Base64"]
41136
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
42137

138+
[[MarkdownAST]]
139+
deps = ["AbstractTrees", "Markdown"]
140+
git-tree-sha1 = "465a70f0fc7d443a00dcdc3267a497397b8a3899"
141+
uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"
142+
version = "0.1.2"
143+
144+
[[MbedTLS_jll]]
145+
deps = ["Artifacts", "Libdl"]
146+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
147+
version = "2.28.2+1"
148+
43149
[[Mmap]]
44150
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
45151

152+
[[MozillaCACerts_jll]]
153+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
154+
version = "2023.1.10"
155+
46156
[[NetworkOptions]]
47157
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
158+
version = "1.2.0"
159+
160+
[[OpenSSL_jll]]
161+
deps = ["Artifacts", "JLLWrappers", "Libdl"]
162+
git-tree-sha1 = "a028ee3cb5641cccc4c24e90c36b0a4f7707bdf5"
163+
uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
164+
version = "3.0.14+0"
165+
166+
[[PCRE2_jll]]
167+
deps = ["Artifacts", "Libdl"]
168+
uuid = "efcefdf7-47ab-520b-bdef-62a2eaa19f15"
169+
version = "10.42.0+1"
48170

49171
[[Parsers]]
50-
deps = ["Dates"]
51-
git-tree-sha1 = "438d35d2d95ae2c5e8780b330592b6de8494e779"
172+
deps = ["Dates", "PrecompileTools", "UUIDs"]
173+
git-tree-sha1 = "8489905bcdbcfac64d1daa51ca07c0d8f0283821"
52174
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
53-
version = "2.0.3"
175+
version = "2.8.1"
176+
177+
[[Pkg]]
178+
deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
179+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
180+
version = "1.10.0"
181+
182+
[[PrecompileTools]]
183+
deps = ["Preferences"]
184+
git-tree-sha1 = "5aa36f7049a63a1528fe8f7c3f2113413ffd4e1f"
185+
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
186+
version = "1.2.1"
187+
188+
[[Preferences]]
189+
deps = ["TOML"]
190+
git-tree-sha1 = "9306f6085165d270f7e3db02af26a400d580f5c6"
191+
uuid = "21216c6a-2e73-6563-6e65-726566657250"
192+
version = "1.4.3"
54193

55194
[[Printf]]
56195
deps = ["Unicode"]
@@ -61,21 +200,66 @@ deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
61200
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
62201

63202
[[Random]]
64-
deps = ["Serialization"]
203+
deps = ["SHA"]
65204
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
66205

206+
[[RegistryInstances]]
207+
deps = ["LazilyInitializedFields", "Pkg", "TOML", "Tar"]
208+
git-tree-sha1 = "ffd19052caf598b8653b99404058fce14828be51"
209+
uuid = "2792f1a3-b283-48e8-9a74-f99dce5104f3"
210+
version = "0.1.0"
211+
67212
[[SHA]]
68213
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
214+
version = "0.7.0"
69215

70216
[[Serialization]]
71217
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
72218

73219
[[Sockets]]
74220
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
75221

222+
[[TOML]]
223+
deps = ["Dates"]
224+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
225+
version = "1.0.3"
226+
227+
[[Tar]]
228+
deps = ["ArgTools", "SHA"]
229+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
230+
version = "1.10.0"
231+
76232
[[Test]]
77233
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
78234
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
79235

236+
[[TranscodingStreams]]
237+
git-tree-sha1 = "60df3f8126263c0d6b357b9a1017bb94f53e3582"
238+
uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
239+
version = "0.11.0"
240+
weakdeps = ["Random", "Test"]
241+
242+
[TranscodingStreams.extensions]
243+
TestExt = ["Test", "Random"]
244+
245+
[[UUIDs]]
246+
deps = ["Random", "SHA"]
247+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
248+
80249
[[Unicode]]
81250
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
251+
252+
[[Zlib_jll]]
253+
deps = ["Libdl"]
254+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
255+
version = "1.2.13+1"
256+
257+
[[nghttp2_jll]]
258+
deps = ["Artifacts", "Libdl"]
259+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
260+
version = "1.52.0+1"
261+
262+
[[p7zip_jll]]
263+
deps = ["Artifacts", "Libdl"]
264+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"
265+
version = "17.4.0+2"

‎docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33

44
[compat]
5-
Documenter = "~0.23"
5+
Documenter = "1"

‎docs/src/examples.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,7 @@ WGLMakie.mesh(vts, map(v -> GeometryBasics.TriangleFace(v...), fcs))
3232

3333
![cta cardio](./img/ctacardio.png)
3434

35-
## Functions
36-
37-
```julia
38-
using Meshing
39-
using FileIO # MeshIO should also be installed
40-
using GeometryBasics
41-
42-
gyroid(v) = cos(v[1])*sin(v[2])+cos(v[2])*sin(v[3])+cos(v[3])*sin(v[1])
43-
gyroid_shell(v) = max(gyroid(v)-0.4,-gyroid(v)-0.4)
44-
45-
# generate directly using GeometryBasics API
46-
# Rect specifies the sampling intervals
47-
gy_mesh = Mesh(gyroid_shell, Rect(Vec(0,0,0),Vec(pi*4,pi*4,pi*4)),
48-
MarchingCubes(), samples=(50,50,50))
49-
50-
save("gyroid.ply", gy_mesh)
51-
52-
# view with Makie
53-
import Makie
54-
using LinearAlgebra
55-
Makie.mesh(gy_mesh, color=[norm(v) for v in coordinates(gy_mesh)])
56-
```
57-
58-
![gyroid](./img/gyroid.png)
59-
60-
61-
## Isocaps
35+
## Gyroid and Isocaps
6236

6337
We do not provide an equivalent to `isocaps` in Matlab, though
6438
a similar result may be achieved by setting the boundary to a large value:
@@ -79,10 +53,10 @@ A[end,:,:] .= 1e10
7953
A[:,end,:] .= 1e10
8054
A[:,:,end] .= 1e10
8155

82-
gy_mesh = GLNormalMesh(A, MarchingCubes())
56+
vts, fcs = isosurface(A, MarchingCubes())
8357

8458
# view with Makie
85-
import Makie
59+
import WGLMakie
8660
using LinearAlgebra
87-
Makie.mesh(gy_mesh, color=[norm(v) for v in gy_mesh.vertices])
61+
WGLMakie.mesh(vts, map(v -> GeometryBasics.TriangleFace(v...), fcs), color=[norm(v) for v in v])
8862
```

‎src/isosurface.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
1010
`isosurface` is the general interface to all isosurface extraction algorithms.
1111
12-
Returns: (Vector, Vector{FaceType})
12+
Returns: (Vector{NTuple{3, T}, }, Vector{NTuple{3, Int}})
1313
1414
Defaults:
1515
`method` must be an instance of an `AbstractMeshingAlgorithm`, e.g.:

0 commit comments

Comments
 (0)