PECOS/mkdocs.yml at dev · PECOS-packages/PECOS · 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
site_name: PECOS Documentation
docs_dir: docs
site_dir: site
use_directory_urls: false
site_url: https://pecos-packages.github.io/PECOS/
repo_url: https://github.com/PECOS-packages/PECOS
repo_name: PECOS-packages/PECOS
site_description: Documentation for the Performance Estimator of Codes On Surfaces
  (PECOS) library
site_author: The PECOS Developers
theme:
  name: material
  locale: en
  logo: assets/images/pecos_icon.svg
  favicon: assets/images/pecos_icon.svg
  toc_depth: 1
  icon:
    repo: fontawesome/brands/github
  font:
    text: Proxima Nova
    code: Source Code Pro
  palette:
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: custom
    accent: deep orange
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: custom
    accent: deep orange
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
  - navigation.tracking
  - navigation.instant
  - navigation.footer
  - navigation.top
  - toc.follow
  - content.code.copy
  - content.code.annotate
  - content.tabs.link
  - search.highlight
  - search.suggest
  - search.share
nav:
- Home: README.md
- User Guide:
  - Getting Started: user-guide/getting-started.md
  - PECOS Concepts: user-guide/pecos-concepts.md
  - Command Line Interface: user-guide/cli.md
  - QASM Simulation: user-guide/qasm-simulation.md
  - WASM Foreign Objects: user-guide/wasm-foreign-objects.md
  - HUGR & Guppy Simulation: user-guide/hugr-simulation.md
  - Simulators: user-guide/simulators.md
  - Engine Selection: user-guide/engine-selection.md
  - Gate Reference: user-guide/gates.md
  - Gate Naming Conventions: user-guide/gate-naming-conventions.md
  - Gate Naming (Future): user-guide/gate-naming-speculation.md
  - Gate and Angle Types: user-guide/gate-angle-types.md
  - Noise Model Builders: user-guide/noise-model-builders.md
  - Quantum Operator Algebra: user-guide/quantum-operator-algebra.md
  - Quantum Information Primitives: user-guide/quantum-info.md
  - Stabilizer Codes: user-guide/stabilizer-codes.md
  - Pauli Algebra and QEC in Python: user-guide/python-pauli-qec.md
  - Fault Tolerance Analysis: user-guide/fault-tolerance.md
  - Fault Catalog Tutorial: user-guide/fault-catalog.md
  - QEC Geometry: user-guide/qec-geometry.md
  - QEC with Guppy: user-guide/qec-guppy.md
  - Decoders: user-guide/decoders.md
  - Graph API: user-guide/graph-api.md
  - Circuit Representation: user-guide/circuit-representation.md
  - Parallel Execution: user-guide/parallel-execution.md
  - LLVM Setup: user-guide/llvm-setup.md
  - CUDA Setup: user-guide/cuda-setup.md
  - cmake Setup (MWPF): user-guide/cmake-setup.md
- Concepts:
  - concepts/index.md
  - StabVec Simulator: concepts/clifford-rz-simulator.md
- API:
  - api/api-reference.md
- Development:
  - development/DEVELOPMENT.md
  - Developer Tools CLI: development/dev-tools.md
  - Documentation Testing: development/doc-testing.md
  - SLR and QECLib: development/slr-qeclib.md
  - AST Infrastructure: development/ast-infrastructure.md
  - Foreign Language Plugins: development/foreign-plugins.md
  - Parallel Blocks: development/parallel-blocks-and-optimization.md
- Experimental:
  - experimental/index.md
  - Composable Noise (pecos-neo): experimental/composable-noise.md
- Proposals:
  - proposals/README.md
- Releases:
  - releases/changelog.md
markdown_extensions:
- admonition
- codehilite
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.arithmatex:
    generic: true
- toc:
    permalink: true
    toc_depth: 3
- tables
- footnotes
- pymdownx.details
- pymdownx.tasklist:
    custom_checkbox: true
extra_css:
- assets/css/custom.css
extra_javascript:
- assets/js/mathjax.js
- assets/js/custom.js
plugins:
- search:
    lang: en
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: google
          show_source: true
- markdown-exec
extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/PECOS-packages/PECOS
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/quantum-pecos/
  - icon: fontawesome/solid/book
    link: https://quantum-pecos.readthedocs.io/
copyright: Copyright &copy; 2018-2026 The PECOS Developers