UltrafastEngine/mkdocs.yml at main · JosephCodemard/UltrafastEngine · 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
site_name: UltrafastEngine
site_description: Nonlinear ultrafast pulse propagation through complete optical systems
site_url: https://josephcodemard.github.io/UltrafastEngine/
repo_url: https://github.com/JosephCodemard/UltrafastEngine
edit_uri: edit/main/docs/
docs_dir: docs
# CLAUDE.md files are instructions for Claude Code, not pages of the site
exclude_docs: |
  CLAUDE.md
theme:
  name: readthedocs
  custom_dir: overrides            # main.html adds the long logo as a footer
  logo: img/logo/ultrafast-logo-large-dark.svg   # sidebar (light text on the blue sidebar); generated by assets/logo/make_logo.py
extra_css:
  - css/brand.css                  # logo palette for the sidebar and links
nav:
  - Home: index.md
  - Install and build: install.md
  - Getting started: getting-started.md
  - Capabilities & limitations: capabilities.md
  - Tutorials:
      - Overview: tutorials/index.md
      - 1. Your first simulation: tutorials/01-first-run.md
      - 2. Diagnostics: tutorials/02-diagnostics.md
      - 3. Larger systems: tutorials/03-larger-systems.md
      - 4. Your own measured data: tutorials/04-measured-data.md
      - 5. Contrast of an amplifier chain: tutorials/05-contrast.md
      - 6. Diffraction by an iris: tutorials/06-diffraction.md
  - Examples: examples/README.md
  - Gallery: gallery.md
  - Assets (synthetic data with answer keys): assets/README.md
  - Concepts: concepts.md
  - Architecture:
      - Overview: architecture/index.md
      - Code map: architecture/code-map.md
      - Key processes: architecture/processes.md
  - Model levels: model-levels.md
  - Reference:
      - System file: reference/system-file.md
      - Run spec: reference/run-spec.md
      - Models & overrides: reference/models.md
      - Materials: reference/materials.md
      - Material catalogue (sources, status): reference/materials-catalogue.md
      - Gases (rotational Raman): reference/gases.md
      - Surfaces, losses, polarisation: reference/coatings.md
      - Optical components: reference/components.md
      - Delayed light (tails, ghosts, echoes): reference/delayed-light.md
      - Nonlinear physics & solvers: reference/nonlinear.md
      - Fibres & waveguides: reference/fibers.md
      - Ionisation & plasma: reference/ionization.md
      - Active elements & aux beams: reference/active-elements.md
      - Crystals (χ(2)): reference/crystals.md
      - Pulse calculator (TBP): reference/pulse-calculator.md
      - Gain media & amplifiers: reference/gain.md
      - Oscillators & saturable absorbers: reference/oscillators.md
      - Branched systems: reference/branches.md
      - Position-dependent properties: reference/spatial-properties.md
      - Spatial models: reference/transverse.md
      - Modulator (pixelated devices): reference/modulator.md
      - Instruments: reference/instruments.md
      - Measured data: reference/measured-data.md
      - Pulse retrieval: reference/retrieval.md
      - Parameter studies: reference/studies.md
      - Speed & compute back-ends: reference/speed.md
      - Results: reference/results.md
      - Option reference (generated): reference/options.md
      - Schemas, validation & migrations: reference/schema.md
      - Plugin system: reference/plugins.md
  - Interfaces:
      - Python: reference/python.md
      - Python API (generated): reference/python-api.md
      - C API (C/C++): reference/c-api.md
      - Extending: reference/extending.md
  - Plugins:
      - Overview: plugins/index.md
      - Installing plugins: plugins/installing.md
      - Fitting (transforms, fits, backward): plugins/fitting.md
      - Adaptive optics (DM, SLM, tiles, shaping): plugins/ao.md
      - Digital twin: plugins/twin.md
      - Zemax OpticStudio: plugins/zemax.md
      - GPU (CUDA, OpenCL): plugins/gpu.md
      - HITRAN (gas lines in air): plugins/hitran.md
  - Testing & validation:
      - Overview: testing.md
      - Component verification (scripts and plots): component-tests.md
      - Validation matrix (generated): reference/validation-matrix.md
      - Paper replications: papers/README.md
  - Roadmap: roadmap.md
  - For AI agents: agents.md
  - Claude Code: claude-code.md
  - Releasing (build.sh): releasing.md
  - Design notes:
      - Development history: design/history.md
      - "Next steps": design/next-steps.md
      - "Backlog (parked design)": design/backlog.md
markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true