mkdocs.yml

# SPDX-License-Identifier: AGPL-3.0-or-later
# Commercial license available
# © Concepts 1996–2026 Miroslav Šotek. All rights reserved.
# © Code 2020–2026 Miroslav Šotek. All rights reserved.
# ORCID: 0009-0009-3560-0851
# Contact: www.anulum.li | protoscience@anulum.li
# SCPN Quantum Control — Mkdocs
site_name: scpn-quantum-control
site_url: https://anulum.github.io/scpn-quantum-control
site_description: Quantum simulation of coupled oscillators on IBM hardware
site_author: Miroslav Šotek

repo_url: https://github.com/anulum/scpn-quantum-control
repo_name: anulum/scpn-quantum-control
edit_uri: edit/main/docs/

# Internal operational notes, audits, correspondence, and raw OCR/PDF extracts
# are retained locally for auditability, but they are not public site pages.
exclude_docs: |
  internal/**

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - search.highlight
  logo: assets/anulum_logo.png
  favicon: assets/anulum_logo_company.jpg
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Theory:
      - SCPN Foundations: theory.md
      - Equations: equations.md
      - Architecture: architecture.md
      - Research Gems: research_gems.md
      - Literature Catalogue: literature/README.md
      - Literature Survey 2024-2026: literature/literature_survey_2024_2026.md
      - Orchestrator Integration: orchestrator_integration.md
  - API Reference:
      - Stable Facades API: stable_facades_api.md
      - Stable Core API: stable_core_api.md
      - Stable Core Preflight Fixtures: stable_core_preflight_fixtures.md
      - Stable Core Backend Capability Matrix: stable_core_backend_capability_matrix.md
      - Kuramoto Core Facade: kuramoto_core_facade.md
      - Core Package Boundary: core_package_boundary.md
      - API Overview: api.md
      - GOTM-SCPN Paper 0 Index: paper0/README.md
      - GOTM-SCPN Paper 0 Validation Register: paper0/paper0_validation_register.md
      - GOTM-SCPN Paper 0 Processing Methodology: paper0/paper0_processing_methodology.md
      - GOTM-SCPN Paper 0 Experimental Pathway: paper0/paper0_experimental_pathway.md
      - GOTM-SCPN Paper 0 Lane Registry: paper0/paper0_lane_registry.md
      - GOTM-SCPN Paper 0 Methodology Paper Outline: paper0/paper0_methodology_paper_outline.md
      - GOTM-SCPN Paper 0 First Preregistered Experiment: paper0/paper0_first_preregistered_downstream_experiment.md
      - GOTM-SCPN Paper 0 K_nm Preregistered Replay: paper0/paper0_knm_preregistered_replay.md
      - GOTM-SCPN Paper 0 K_nm Replay Contract: paper0/paper0_knm_preregistered_replay_contract.md
      - GOTM-SCPN Paper 0 K_nm Evidence Checklist: paper0/paper0_knm_measured_coupling_evidence_checklist.md
      - Runtime Contracts:
          - QPU Data Artifact: qpu_data_artifact.md
          - Pipeline Runtime Contract: pipeline_runtime_contract.md
          - QPU Compute Unit: qpu_compute_unit.md
          - QPU Provider Readiness: qpu_provider_readiness.md
      - QPU System Capability Dossier: qpu_system_capability_dossier.md
      - Pipeline Performance: pipeline_performance.md
      - S2 Scaling Readiness Index: campaigns/s2_scaling_readiness_index_2026-05-06.md
      - S3 Design Readiness Index: campaigns/s3_design_readiness_index_2026-05-06.md
      - Hybrid Feedback Loop S1: campaigns/hybrid_feedback_loop_s1_2026-05-06.md
      - S1 Feedback Readiness Index: campaigns/s1_feedback_readiness_index_2026-05-06.md
      - S1 Live Submission Preflight: campaigns/s1_live_submission_preflight_2026-05-06.md
      - Artifact Storage Audit: artifact_storage.md
      - Advanced Module Reference:
          - Auto-Generated Module Index: autodoc.md
          - Analysis API: analysis_api.md
          - Phase API: phase_api.md
          - Identity API: identity_api.md
          - Mitigation API: mitigation_api.md
          - Bridges API: bridges_api.md
          - Real-Time Feedback: realtime_feedback.md
          - Analog Kuramoto Backends: analog_backends.md
          - Hybrid Digital-Analog Execution: hybrid_digital_analog.md
          - DLA-Protected Logical Synchronisation: dla_protected_subspace.md
          - DLA-Protected Scar Memory: dla_protected_scar_memory.md
          - Kuramoto Variants: kuramoto_variants.md
          - Witness Discovery: witness_discovery.md
          - Application Benchmark Plugins: application_benchmarks.md
          - Real-Data Synchronisation Forecasting: real_data_sync_forecasting.md
          - Classical Baselines: classical_baselines.md
          - Benchmarks API: benchmarks_api.md
          - Rust Engine: rust_engine.md
          - "Bench: Dynamic Coupling": bench_dynamic_coupling.md
          - "Bench: Structured Ansatz": bench_structured_ansatz.md
          - "Bench: HW Topological Optimizer": bench_hw_topological_optimizer.md
          - Test Infrastructure: test_infrastructure.md
  - Publications:
      - "Preprint: Quantum Kuramoto-XY on Hardware": preprint.md
      - "Paper: Synchronisation Witnesses": paper_sync_witnesses.md
      - "Paper: DLA Parity Theorem": paper_dla_parity.md
      - "Paper Plan: SCPN/FIM Hamiltonian": campaigns/scpn_fim_hamiltonian_paper_plan_2026-05-05.md
      - "Protocol: SCPN/FIM Validation": campaigns/scpn_fim_validation_protocol_2026-05-05.md
      - "Claim Boundary: SCPN/FIM": campaigns/scpn_fim_claim_boundary_2026-05-05.md
      - "DLA-parity Validation": dla_parity.md
      - "Classical Irreproducibility": classical_irreproducibility.md
      - Hardware Status Ledger: hardware_status_ledger.md
      - Hardware Result Packs: hardware_result_packs.md
      - Hardware Result-Pack Release Checklist: hardware_result_pack_release_checklist.md
      - Results Gallery: results.md
      - Methods Benchmark Dashboard: methods_benchmark_dashboard.md
      - Synchronisation Benchmark Suite: synchronisation_benchmark_suite.md
      - Symmetry-Sector Mitigation Compiler: symmetry_sector_mitigation_compiler.md
      - Symmetry-Sector Mitigation Fixtures: symmetry_sector_mitigation_fixtures.md
      - Kuramoto Ring n=4 Benchmark: synchronisation_benchmark_kuramoto_ring_n4.md
      - Kuramoto Chain n=8 Benchmark: synchronisation_benchmark_kuramoto_chain_n8.md
  - Hardware:
      - IBM Guide: hardware_guide.md
      - Experiment Roadmap: EXPERIMENT_ROADMAP.md
      - Results & Claims: PAPER_CLAIMS.md
      - Crypto Research: QUANTUM_CRYPTO_RESEARCH_BRANCH.md
  - Learning:
      - Tutorials: tutorials.md
      - Physics-First Kuramoto-XY: physics_first_kuramoto_xy.md
      - Notebooks: notebooks.md
  - Roadmap:
      - Strategic Roadmap: strategic_roadmap.md
      - Release Readiness Gate: release_readiness.md
      - Actions History Dashboard: actions_history_dashboard.md
      - Campaign Artefacts: campaigns/README.md
      - Publication Operations: publication/README.md
      - E2E Contract Boundaries: e2e_contract_boundaries.md
      - pyOpenSci Submission Readiness: publication/pyopensci_submission_readiness_2026-05-06.md
      - arXiv Source Packaging Readiness: publication/arxiv_source_packaging_readiness_2026-05-06.md
      - SciPy 2026 CFP Readiness: publication/scipy_2026_cfp_readiness_2026-05-06.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true
  - tables
  - attr_list

extra_css:
  - css/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  # GoatCounter (privacy-friendly, no cookies, no personal data).
  # Shared `anulum.goatcounter.com` site covers every anulum project
  # page; per-host and per-path breakdown is available in the dashboard.
  - js/goatcounter.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            members_order: source