Add Docs for Mesh Loading (#189)

* Create meshes.md * Update make.jl for mesh docs * Link to CombinatorialSpaces.jl docs for meshes * Fixed broken links --------- Co-authored-by: Luke Morris <[email protected]>
AlgebraicJulia · Dec 11, 2024 · 10695ac · 10695ac
1 parent 9ef6b0d
commit 10695ac
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -49,6 +49,7 @@ makedocs(
     "Decapodes.jl" => "index.md",
     "Overview" => "overview/overview.md",
     "Equations" => "equations/equations.md",
+    "Meshes" => "meshes/meshes.md",
     "Vortices" => "navier_stokes/ns.md",
     "Harmonics" => "harmonics/harmonics.md",
     "Cahn-Hilliard" => "ch/cahn-hilliard.md",

diff --git a/docs/src/meshes/meshes.md b/docs/src/meshes/meshes.md
@@ -0,0 +1,9 @@
+# Mesh Generation
+
+For information on how to generate meshes, please consult the [Meshes page](https://algebraicjulia.github.io/CombinatorialSpaces.jl/dev/meshes/) of the CombinatorialSpaces.jl docs, and see the following examples:
+
+- [Imperative Grids](https://github.com/AlgebraicJulia/Decapodes.jl/blob/main/examples/grid_meshes.jl)
+- [Imperative Spherical Meshes](https://github.com/AlgebraicJulia/CombinatorialSpaces.jl/blob/64f44241d3f0c9dd2eaaf2b33ed93bef101f54a8/src/Meshes.jl#L187)
+- [By Gluing Triangles to the ACSet](https://github.com/AlgebraicJulia/CombinatorialSpaces.jl/blob/87da8ea13901d30e612bd108406485f85734644a/test/DiscreteExteriorCalculus.jl#L381)
+- [From an OBJ downloaded remotely](https://github.com/AlgebraicJulia/Decapodes.jl/blob/5db4865fbed07b93149b44315838dba50c23da32/examples/chemistry/brusselator_teapot.jl#L32)
+- [From a serialized JSON ACSet](https://github.com/AlgebraicJulia/Decapodes.jl/blob/83efc30769218aa6e882c241972d08c44f7155fb/src/meshes.jl#L44)