HyperCoast/mkdocs.yml at main · opengeos/HyperCoast · 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
site_name: HyperCoast
site_description: A Python package for processing hyperspectral data in coastal regions
site_author: giswqs
site_url: https://hypercoast.org
repo_url: https://github.com/opengeos/HyperCoast

copyright: "Copyright &copy; 2024 - 2024 Bingqing Liu & Qiusheng Wu"

theme:
    palette:
        - scheme: default
          #   primary: blue
          #   accent: indigo
          toggle:
              icon: material/toggle-switch-off-outline
              name: Switch to dark mode
        - scheme: slate
          primary: indigo
          accent: indigo
          toggle:
              icon: material/toggle-switch
              name: Switch to light mode
    name: material
    icon:
        repo: fontawesome/brands/github
    # logo: assets/logo.png
    # favicon: assets/favicon.png
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.top
        - search.highlight
        - search.share
    custom_dir: "docs/overrides"
    font:
        text: Google Sans
        code: Regular

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - git-revision-date-localized:
          enable_creation_date: true
          type: timeago
    # - pdf-export
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True
          execute: false
          allow_errors: false
          ignore: ["conf.py"]
          execute_ignore:
              [
                  "acolite.ipynb",
                  "acolite_emit.ipynb",
                  "search_data.ipynb",
                  "ecostress.ipynb",
                  "aviris.ipynb",
                  "image_cube.ipynb",
                  "image_slicing.ipynb",
                  "temperature.ipynb",
                  "pace_oci_l1.ipynb",
                  "chla_predict.ipynb",
                  "pace_cyano.ipynb",
                  "_earthaccess.ipynb",
              ]

markdown_extensions:
    - admonition
    - abbr
    - attr_list
    - def_list
    - footnotes
    - meta
    - md_in_html
    - pymdownx.superfences
    - pymdownx.highlight:
          linenums: true
    - toc:
          permalink: true

# extra:
#     analytics:
#         provider: google
#         property: UA-XXXXXXXXX-X

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - Contributing: contributing.md
    - Changelog: changelog.md
    - Report Issues: https://github.com/opengeos/HyperCoast/issues
    - Examples:
          - examples/overview.md
          - examples/acolite.ipynb
          - examples/acolite_emit.ipynb
          - examples/search_data.ipynb
          - examples/image_cube.ipynb
          - examples/image_slicing.ipynb
          - examples/aviris.ipynb
          - examples/desis.ipynb
          - examples/emit.ipynb
          - examples/neon.ipynb
          - examples/pace.ipynb
          - examples/ecostress.ipynb
          - examples/chlorophyll_a.ipynb
          - examples/chla_predict.ipynb
          - examples/temperature.ipynb
          - examples/pace_oci_l1.ipynb
          - examples/pace_oci_l2.ipynb
          - examples/pace_cyano.ipynb
          - examples/multispectral.ipynb
          - examples/pca.ipynb
          - examples/field_data.ipynb
          - examples/hypoxia.ipynb
          - examples/tanager.ipynb
          - examples/tanager_3d.ipynb
          - examples/prisma.ipynb
          - examples/enmap.ipynb
          - examples/moe_vae_chla.ipynb
          - examples/moe_vae_acdom.ipynb
          - examples/moe_vae_tss.ipynb
          - examples/wyvern.ipynb
          - examples/EMIT_aCDOM.ipynb
          - examples/EMIT_chla.ipynb
          - examples/EMIT_TSS.ipynb
    - Workshops:
          - workshops/emit.ipynb
          - workshops/pace.ipynb
    - API Reference:
          - aviris module: aviris.md
          - chla module: chla.md
          - common module: common.md
          - desis module: desis.md
          - emit module: emit.md
          - hypercoast module: hypercoast.md
          - neon module: neon.md
          - pace module: pace.md
          - prisma module: prisma.md
          - enmap module: enmap.md
          - ui module: ui.md
          - moe_vae modules:
                - data_loading module: moe_vae/data_loading.md
                - model_inference module: moe_vae/model_inference.md
                - model module: moe_vae/model.md
                - plot_and_save module: moe_vae/plot_and_save.md
          - emit_utils modules:
                - data_loading module: emit_utils/data_loading.md
                - model_inference module: emit_utils/model_inference.md
                - moe_vae module: emit_utils/moe_vae.md
                - plot_and_save module: emit_utils/plot_and_save.md
                - preprocess module: emit_utils/preprocess.md