mkdocs.yml

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
  - 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
  - Gate Reference: user-guide/gates.md
  - Gate Naming Conventions: user-guide/gate-naming-conventions.md
  - Gate Naming (Future): user-guide/gate-naming-speculation.md
  - Noise Model Builders: user-guide/noise-model-builders.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
- 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
  - Circuit Representations: development/circuit-representations.md
  - Parallel Blocks: development/parallel-blocks-and-optimization.md
  - development/QIS_ARCHITECTURE.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 © 2018-2025 The PECOS Developers