cubedynamics/mkdocs.yml at main · CU-ESIIL/cubedynamics · 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
site_name: "CubeDynamics"
site_description: "CubeDynamics: a grammar of streaming environmental computation."
site_author: CubeDynamics Team
site_url: "https://cu-esiil.github.io/cubedynamics/"

nav:
  - Home: index.md
  - Getting Started: quickstart.md
  - Why CubeDynamics?: why_cubedynamics.md
  - Streaming Environmental Data:
      - Overview: streaming/index.md
      - What is Streaming?: streaming/what_is_streaming.md
      - Virtual Cubes: concepts/virtual_cubes.md
      - Local Sources: streaming/local_sources.md
      - Cloud Sources: streaming/cloud_sources.md
      - STAC Sources: streaming/stac_sources.md
  - Grammar of Streaming:
      - Overview: grammar/index.md
      - Pipe: api/pipe.md
      - Verbs: api/verbs.md
      - Lazy Evaluation: grammar/lazy_evaluation.md
      - Workflow Composition: grammar/workflow_composition.md
      - What is a cube?: concepts/cubes.md
      - Glossary: concepts/glossary.md
      - Why not xarray?: why_not_xarray.md
  - Workflows:
      - Overview: workflows/index.md
      - Climate Analysis: workflows/climate_analysis.md
      - Fire Analysis: workflows/fire_analysis.md
      - Vegetation Analysis: workflows/vegetation_analysis.md
      - Remote Sensing Analysis: workflows/remote_sensing_analysis.md
      - Fire VASE / FireHull: capabilities/fire-vase.md
  - Datasets:
      - Overview: datasets/index.md
      - Which dataset should I use?: datasets/which_dataset.md
      - Compatibility matrix: datasets/compatibility.md
      - gridMET: datasets/gridmet.md
      - PRISM: datasets/prism.md
      - Sentinel-2 NDVI: datasets/sentinel2_ndvi.md
      - Landsat 8 (MPC): datasets/landsat8_mpc.md
      - FIRED: datasets/fired.md
  - Recipes / How-tos:
      - Overview: recipes/index.md
      - Cube math primitives: recipes/cube_math_primitives.md
      - gridMET variance cube: recipes/gridmet_variance_cube.md
      - PRISM variance cube: recipes/prism_variance_cube.md
      - Fire event vase + climate merge (fire_plot): recipes/fire_event_vase_hull.md
      - Synthetic fire/VASE recipe: recipes/fire_vase_synthetic.md
      - Sentinel-2 NDVI z-score cube: recipes/s2_ndvi_zcube.md
      - Sentinel-2 correlation center: recipes/s2_corr_center.md
      - Sentinel-2 tail dependence (center): recipes/s2_tail_dep_center.md
      - Sentinel-2 tail dependence (manual): recipes/s2_tail_dep_manual.md
  - Visualization:
      - Overview: viz/index.md
      - Cube viewer (v.plot): viz/cube_viewer.md
      - Maps (v.map): viz/maps.md
      - Suitability tubes: viz/suitability_tubes.md
  - API:
      - Overview: api/index.md
      - Pipe: api/pipe.md
      - Verbs: api/verbs.md
      - Data: api/data.md
      - Visualization: api/viz.md
      - Inventory (User): function_inventory.md
      - Inventory (Full / Dev): api/inventory_full.md
      - Reference: api/reference.md
  - Developer:
      - Contributing: dev/contributing.md
      - CI and Testing: dev/ci_testing.md
      - Concepts Overview: concepts/index.md
      - Cube viewer invariants: dev/cube_viewer_invariants.md
      - Fire / VASE status audit: developer/fire_vase_status.md
      - Fire plot architecture: dev/fire_plot_architecture.md
      - Figure backend (v.plot): dev/figure_backend.md
      - Viewer backend: dev/viewer_backend.md
      - Legacy reference: dev/legacy_reference.md
      - Public API & scope: project/public_api.md
      - Project Scope: project/scope.md
      - Deprecation inventory: project/deprecation_inventory.md
  - Design:
      - Spatial & CRS Dataset Contract: design/spatial_dataset_contract.md

repo_url: https://github.com/CU-ESIIL/cubedynamics
edit_uri: edit/main/docs/

copyright: 'Copyright \u00a9 2024'

theme:
  name: material
  language: en
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
  palette:
    - scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  logo: assets/img/cubedynamics_banner.png
  favicon: assets/img/cubedynamics_favicon.png
  custom_dir: docs/overrides

extra_css:
  - stylesheets/brand.css
  - stylesheets/extra.css
  - assets/styles/landing_cards_v2.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - code
          options:
            docstring_style: numpy
            merge_init_into_class: true
            show_source: false
  - git-revision-date
  - mkdocs-jupyter:
      include_source: true
      ignore_h1_titles: true

markdown_extensions:
  - toc:
      toc_depth: 2