Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add Docs for Mesh Loading #189

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add Docs for Mesh Loading #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
052961d
Create meshes.md
jpfairbanks Jan 24, 2024
640302e
Update make.jl for mesh docs
jpfairbanks Jan 24, 2024
a5a2e53
Link to CombinatorialSpaces.jl docs for meshes
lukem12345 Jan 26, 2024
7e181bd
Merge branch 'main' into jpf/mesh-docs
jpfairbanks Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,16 @@ makedocs(
checkdocs = :none,
pages = Any[
"Decapodes.jl" => "index.md",
"Halfar-NS" => "halmo.md",
"Overview" => "overview.md",
"Equations" => "equations.md",
"Meshes" => "meshes.md",
"Klausmeier" => "klausmeier.md",
"Glacial Flow" => "ice_dynamics.md",
"Grigoriev Ice Cap" => "grigoriev.md",
"Budyko-Sellers-Halfar" => "budyko_sellers_halfar.md",
"CISM v2.1" => "cism.md",
"NHS" => "nhs.md",
"Equations" => "equations.md",
"Halfar-NS" => "halmo.md",
"ASCII Operators" => "ascii.md",
"Misc Features" => "bc_debug.md",
"Pipe Flow" => "poiseuille.md",
Expand Down
10 changes: 10 additions & 0 deletions docs/src/meshes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# 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/Decapodes.jl/blob/main/examples/sw/spherical_meshes.jl)
- [By Gluing Triangles to the ACSet](https://github.com/AlgebraicJulia/CombinatorialSpaces.jl/blob/87da8ea13901d30e612bd108406485f85734644a/test/DiscreteExteriorCalculus.jl#L381)
- [From an OBJ](https://github.com/AlgebraicJulia/Decapodes.jl/blob/main/test/meshes.jl)
- [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)
Loading