fz.github.io/mkdocs.yml at main · Funz/fz.github.io · 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
site_name: FZ - Parametric Scientific Computing Framework
site_description: Documentation for FZ and its plugins
site_author: Funz Team
site_url: https://funz.github.io/fz
repo_url: https://github.com/Funz/fz
repo_name: Funz/fz

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - attr_list
  - def_list
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Funz/fz
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/funz/
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Core Concepts: getting-started/concepts.md
  - User Guide:
    - Core Functions:
      - fzi - Parse Input: user-guide/core-functions/fzi.md
      - fzc - Compile: user-guide/core-functions/fzc.md
      - fzo - Parse Output: user-guide/core-functions/fzo.md
      - fzr - Run Study: user-guide/core-functions/fzr.md
      - fzd - Design of Experiments: user-guide/core-functions/fzd.md
      - fzl - List Models/Calculators: user-guide/core-functions/fzl.md
    - Model Definition: user-guide/model-definition.md
    - Calculators:
      - Overview: user-guide/calculators/overview.md
      - Local Shell: user-guide/calculators/shell.md
      - SSH Remote: user-guide/calculators/ssh.md
      - SLURM: user-guide/calculators/slurm.md
      - Funz Server: user-guide/calculators/funz.md
      - Cache: user-guide/calculators/cache.md
    - Advanced Features:
      - Parallel Execution: user-guide/advanced/parallel.md
      - Caching Strategy: user-guide/advanced/caching.md
      - Interrupt Handling: user-guide/advanced/interrupts.md
      - Formulas: user-guide/advanced/formulas.md
  - Plugins:
    - Overview: plugins/index.md
    - FZ-Moret: plugins/moret.md
    - FZ-MCNP: plugins/mcnp.md
    - FZ-Cathare: plugins/cathare.md
    - FZ-Cristal: plugins/cristal.md
    - FZ-Scale: plugins/scale.md
    - FZ-Telemac: plugins/telemac.md
  - Examples:
    - Perfect Gas Pressure: examples/perfectgas.md
    - Modelica/OpenModelica: examples/modelica.md
    - Remote HPC: examples/hpc.md
    - Google Colab Notebooks: examples/colab.md
  - Reference:
    - Configuration: reference/configuration.md
    - Environment Variables: reference/environment.md
    - Release Notes: reference/releases.md
    - Troubleshooting: reference/troubleshooting.md
    - API Reference: reference/api.md
  - Contributing:
    - Development: contributing/development.md
    - Testing: contributing/testing.md