-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathmkdocs.yml
102 lines (94 loc) · 3.4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: Spectral Element Library in Fortran
site_description: SELF Documentation
site_author: Fluid Numerics
site_dir: public
site_url: ""
repo_name: GitHub/fluidnumerics/SELF
repo_url: https://github.com/fluidnumerics/SELF
edit_uri: edit/main/docs/mkdocs
# Directory where site content is located
docs_dir: docs
# Site navigation
nav:
- Home: index.md
- Getting Started:
- Installation: GettingStarted/install.md
- Dependencies: GettingStarted/dependencies.md
- Building Applications with SELF: GettingStarted/building-with-self.md
- Using Multiple GPUs: GettingStarted/multi-gpu.md
- Tutorials:
- Burgers Equation:
- Traveling Shock : Tutorials/BurgersEquation1D/TravelingShock.md
- Linear Euler (2D):
- Plane wave propagation: Tutorials/LinearEuler2D/PlaneWavePropagation.md
- Plane wave reflection: Tutorials/LinearEuler2D/PlaneWaveReflection.md
- Spherical sound wave: Tutorials/LinearEuler2D/SphericalSoundWave.md
# - Create your own model: Tutorials/CreateYourOwnModel.md
- Linear Euler (3D):
- Plane wave propagation: Tutorials/LinearEuler3D/PlaneWavePropagation.md
- Spherical sound wave: Tutorials/LinearEuler3D/SphericalSoundWave.md
- Linear Shallow Water (2D):
- Reflecting wave: Tutorials/LinearShallowWater/LinearShallowWater.md
- Kelvin waves: Tutorials/LinearShallowWater/KelvinWaves.md
- Planetary Rossby wave: Tutorials/LinearShallowWater/PlanetaryRossbyWave.md
- Models:
- Viscous Burgers Equation: Models/burgers-equation-model.md
- Linear Euler (2D) : Models/linear-euler-2d-model.md
- Linear Euler (3D) : Models/linear-euler-3d-model.md
- Linear Shallow Water (2D): Models/linear-shallow-water-model.md
# - Generic DG Models: Models/generic-dg-models.md
- Mesh Generation:
- Overview: MeshGeneration/Overview.md
- Structured Mesh Generators: MeshGeneration/StructuredMesh.md
# - Importing other mesh types with HOPr: MeshGeneration/HOPr.md
#- Post Processing:
# - Visualization with PySELF: PostProcessing/VisualizationWithPyself.md
- Learning:
- Theory:
- Spectral Approximations: Learning/SpectralApproximations.md
- Differential Geometry: Learning/DifferentialGeometry.md
- Provable Stability: Learning/ProvableStability.md
- Code:
- Software Architecture: Learning/SoftwareArchitecture.md
- Dependencies: Learning/dependencies.md
- API Documentation: ford/index.html
- Contributing:
- Documentation: Contributing/Documentation.md
theme:
name: material
favicon: assets/images/favicon.png
logo: assets/images/logo-fluid-numerics.png
palette:
- scheme: slate
primary: black
accent: cyan
toggle:
icon: material/brightness-4
name: Switch to light mode
- scheme: default
primary: black
accent: cyan
toggle:
icon: material/brightness-7
name: Switch to dark mode
markdown_extensions:
- toc:
permalink: "#"
- admonition
- pymdownx.arithmatex:
generic: true
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- glightbox