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
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
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.github.io
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
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - redirects:
      redirect_maps:
        user-guide/model-definition.md: user-guide/models/definition.md
        user-guide/advanced/formulas.md: user-guide/templates/formulas.md
        user-guide/advanced/parallel.md: user-guide/running/parallel.md
        user-guide/advanced/caching.md: user-guide/running/caching.md
        user-guide/advanced/interrupts.md: user-guide/running/interrupts.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - 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
  - md_in_html
  - 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-fz/

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:
    - Templates & Models:
      - Input Template Syntax: user-guide/templates/syntax.md
      - Formulas: user-guide/templates/formulas.md
      - Model Definition: user-guide/models/definition.md
      - Output Extraction: user-guide/models/outputs.md
    - 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
    - Calculators:
      - Overview & Aliases: user-guide/calculators/overview.md
      - Local Shell (sh://): user-guide/calculators/shell.md
      - SSH (ssh://): user-guide/calculators/ssh.md
      - SLURM (slurm://, slurm-array://): user-guide/calculators/slurm.md
      - Funz Server (funz://): user-guide/calculators/funz.md
      - Cache (cache://): user-guide/calculators/cache.md
    - Running Studies:
      - Parallelism & Retries: user-guide/running/parallel.md
      - Timeouts: user-guide/running/timeouts.md
      - Caching: user-guide/running/caching.md
      - Results & Traceability: user-guide/running/results.md
      - Interrupt & Resume: user-guide/running/interrupts.md
    - Design of Experiments:
      - Writing Algorithms: user-guide/design/algorithms.md
    - Installing Models & Algorithms: user-guide/installing.md
    - AI Agents (Claude Code, MCP): user-guide/ai-agents.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:
    - CLI: reference/cli.md
    - Python API: reference/api.md
    - .fz Directory & Aliases: reference/configuration.md
    - Environment Variables: reference/environment.md
    - Constraints & Limits: reference/limitations.md
    - Security Model: reference/security.md
    - Troubleshooting: reference/troubleshooting.md
    - Release Notes: reference/releases.md
  - Contributing:
    - Development: contributing/development.md
    - Testing: contributing/testing.md

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn