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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
site_name: SWEEP Documentation
site_description: Seismic Wave Equation Exploration Platform
repo_url: https://github.com/DeepWave-KAUST/sweep
repo_name: DeepWave-KAUST/sweep
edit_uri: edit/dev/docs/
site_url: https://deepwave-kaust.github.io/sweep/
docs_dir: docs
watch:
  - README.md
  - examples
  - src

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo/sweep-icon-transparent.svg
  favicon: assets/logo/sweep-icon-32.png
  font:
    text: Inter Tight
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    # 'navigation.sections' removed — it expanded the left sidebar tree
    # (no collapsing) and visually shrank the notebook content column.
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DeepWave-KAUST/sweep

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - mkdocs-jupyter:
      include_source: true        # required for the per-notebook Download button
      execute: false
      ignore_h1_titles: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            # Inspect (= import) modules at build time so runtime docstring
            # mutations from `WaveEquation.__init_subclass__` (auto-injected
            # SPECS admonitions) are visible to griffe.
            force_inspection: true
            show_source: false
            show_root_heading: true
            docstring_style: google
            docstring_section_style: list
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            merge_init_into_class: true
            line_length: 88
            # Hide noise attributes from the rendered class page:
            #   - "!^_[^_]" — single-underscore private (mkdocstrings default)
            #   - "!^__"    — dunder attributes (``__doc__``, ``__module__``,
            #                 ``__annotations__``, etc.)
            #   - FIELD_SPECS / MODEL_SPECS — already rendered by the
            #     auto-injected admonitions in the class docstring
            #     (``WaveEquation.__init_subclass__``).
            filters:
              - "!^_[^_]"
              - "!^__"
              - "!^FIELD_SPECS$"
              - "!^MODEL_SPECS$"
              - "!^default_pml_type$"
              - "!^supports_apm$"

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
      - Operators: user-guide/operators.md
      - Propagators: user-guide/propagators.md
      - Extending: user-guide/extending.md
      - CLI: user-guide/cli.md
  - Examples:
      - Overview: examples/index.md
      - Notebooks:
          - Hello · SWEEP: notebooks/00_hello_fwi.ipynb
          - FWI:
              - Acoustic · Marmousi: notebooks/01_fwi_acoustic_marmousi.ipynb
              - Acoustic VRZ · FWI imaging: notebooks/17_fwi_vrz_marmousi.ipynb
              - Elastic · Marmousi: notebooks/02_fwi_elastic_marmousi.ipynb
              - Multiscale: notebooks/03_fwi_multiscale.ipynb
              - 3D Overthrust: notebooks/11_fwi_acoustic_overthrust_3d.ipynb
          - NN · FWI:
              - IFWI · SIREN: notebooks/13_ifwi_siren.ipynb
          - Wavefields:
              - DAS: notebooks/04_das_zhao_vs_mu.ipynb
              - Elastic: notebooks/06_wavefield_elastic.ipynb
              - Elastic vector-reflectivity: notebooks/16_elastic_vector_reflectivity.ipynb
              - Topography (irregular FS): notebooks/15_wavefield_topography.ipynb
              - Solver hyperparameters: notebooks/09_solver_hyperparams.ipynb
          - Anisotropic:
              - AcousticVTI: notebooks/05_wavefield_vti.ipynb
              - ElasticTTI: notebooks/10_wavefield_elastic_tti.ipynb
          - Imaging:
              - RTM · Marmousi: notebooks/08_rtm_acoustic_marmousi.ipynb
              - Custom gradient: notebooks/14_custom_gradient.ipynb
              - ADCIG: notebooks/16_adcig.ipynb
          - HPC:
              - Memory strategies: notebooks/07_memory_strategies.ipynb
              - FWI · boundary compression: notebooks/18_fwi_boundary_dtype.ipynb
              - Multi-GPU · DDP vs 1 GPU: notebooks/12_multi_gpu.ipynb
          - Extending:
              - Add a new equation: notebooks/18_extending_add_new_equation.ipynb
      - Scripts:
          - Multi-GPU DDP: examples/multi_gpu_dist.md
  - API Reference:
      - api/index.md
      - Equations:
          - api/equations/index.md
          - Acoustic: api/equations/acoustic.md
          - Acoustic3D: api/equations/acoustic3d.md
          - Acoustic1st: api/equations/acoustic1st.md
          - AcousticVRZ: api/equations/acoustic_vrz.md
          - AcousticLSRTM: api/equations/acoustic_lsrtm.md
          - AcousticLSRTM3D: api/equations/acoustic_lsrtm3d.md
          - Elastic: api/equations/elastic.md
          - Elastic3D: api/equations/elastic3d.md
          - ElasticTTI: api/equations/elastic_tti.md
          - ElasticTTISG: api/equations/elastic_tti_sg.md
          - DAS family: api/equations/das.md
      - Operators:
          - api/operators/index.md
      - Propagators:
          - api/propagators/index.md
          - Propagator Options: api/propagators/options.md
          - PropTorch: api/propagators/prop_torch.md
          - PropJax: api/propagators/prop_jax.md

extra_css:
  - stylesheets/extra.css
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/contrib/auto-render.min.js
  - javascripts/katex.js