sweep/mkdocs.yml at dev · DeepWave-KAUST/sweep · GitHub

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
site_name: SWEEP Documentation
site_description: Seismic Wave Equation Exploration Platform
repo_url: https://github.com/DeepWave-KAUST/sweep
site_url: https://deepwave-kaust.github.io/sweep/
docs_dir: docs
watch:
  - README.md
  - examples
  - src

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Backends: user-guide/backends.md
      - Equations: user-guide/equations.md
      - Propagators: user-guide/propagators.md
      - CLI: user-guide/cli.md
  - Examples:
      - Overview: examples/index.md
      - 2D Acoustic FWI on Marmousi with Torch: examples/acoustic_fwi_torch.md
      - 2D Elastic FWI on Marmousi with Torch: examples/elastic_fwi_torch_marmousi.md
      - 2D Elastic FWI on Overthrust with Torch: examples/elastic_fwi_torch_overthrust.md
      - 2D Acoustic LSRTM on Marmousi with Torch: examples/acoustic_lsrtm_torch.md
      - 2D Acoustic FWI on Marmousi with JAX: examples/acoustic_fwi_jax.md
      - 3D Acoustic FWI on Overthrust with Torch: examples/acoustic_fwi_3d_torch.md
      - 3D Acoustic LSRTM on Overthrust with Torch: examples/acoustic_lsrtm_3d_torch.md
      - Reducing Memory:
          - Overview: examples/reducing_memory.md
          - 2D Acoustic FWI with Source Encoding on Marmousi with Torch: examples/acoustic_fwi_encoding_torch.md
          - Memory Method Compare: examples/memory_method_compare.md
      - Wavefield Examples:
          - Overview: examples/wavefields.md
          - CUDA FD Orders: examples/wavefields_cuda_fd_orders.md
          - Free Surface Forward: examples/wavefields_free_surface.md
          - Anisotropic Wavefields: examples/wavefields_anisotropic.md
          - DAS Figure 4: examples/wavefields_das.md
      - Multi-GPU: examples/multi_gpu.md
      - Joint Migration Inversion: examples/joint_migration_inversion.md
      - Model Assets: examples/model_assets.md
  - API Reference:
      - Overview: api/index.md
      - Equations:
          - Overview: api/equations/index.md
          - Acoustic: api/equations/acoustic.md
          - Acoustic3D: api/equations/acoustic3d.md
          - AcousticVRZ: api/equations/acoustic_vrz.md
          - AcousticLSRTM: api/equations/acoustic_lsrtm.md
          - AcousticLSRTM3D: api/equations/acoustic_lsrtm3d.md
          - Acoustic1st: api/equations/acoustic1st.md
          - Elastic: api/equations/elastic.md
          - Elastic3D: api/equations/elastic3d.md
      - Propagators:
          - Overview: api/propagators/index.md
          - Propagator Options: api/propagators/options.md
          - PropTorch: api/propagators/prop_torch.md
          - PropJax: api/propagators/prop_jax.md