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 Control — Neuro-symbolic stochastic Petri net control for fusion plasma systems.

site_name: SCPN Control
site_description: Neuro-symbolic stochastic Petri net control for fusion plasma systems
site_url: https://anulum.github.io/scpn-control/
repo_url: https://github.com/anulum/scpn-control
repo_name: anulum/scpn-control
copyright: >-
  © 1996–2026 Miroslav Šotek · AGPL-3.0-or-later · commercial licence available ·
  ORCID 0009-0009-3560-0851 · <a href="https://www.anulum.li">anulum.li</a>

docs_dir: docs
site_dir: site

exclude_docs: |
  internal/**

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.top
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            signature_crossrefs: true
            separate_signature: true

nav:
  - Home: index.md
  - Getting Started:
    - Pitch: pitch.md
    - Use Cases: use_cases.md
    - Onboarding: onboarding.md
    - First Steps: tutorials/first_steps.md
    - Tutorials: tutorials.md
    - Notebook Gallery: notebooks.md
    - FAQ: faq.md
  - Learning:
    - Plasma Physics Primer: learning/plasma_physics_primer.md
    - Control Theory Primer: learning/control_theory_primer.md
    - Glossary: learning/glossary.md
  - Reference:
    - API Reference: api.md
    - Synthetic Controller Benchmark: control_benchmark_suite.md
    - Exact-current LIF Runtime: guides/exact_current_lif_runtime.md
    - Native C and Lean API: _generated/native_api_reference.md
    - Theory: theory.md
    - Gyrokinetic Transport: gyrokinetic_transport.md
    - Signed TGLF Fluxes: tglf_flux.md
    - Conservative Face Transport: transport_flux.md
    - Paper 27 Phase Dynamics: paper27_phase_dynamics.md
    - Paper 27 Reviewer Integration: REVIEWER_PAPER27_INTEGRATION.md
    - Architecture: architecture.md
    - Architecture Decisions:
      - ADR Index: adr/index.md
      - Module and Repository Boundaries: adr/0001-module-and-repository-boundaries.md
      - Python, Rust, and PyO3 Dispatch: adr/0002-python-rust-pyo3-dispatch.md
      - Solver and Algorithm Selection: adr/0003-solver-and-algorithm-selection.md
      - Validation, Data, and Evidence Strategy: adr/0004-validation-data-and-evidence-strategy.md
      - Public and Internal API Boundaries: adr/0005-public-and-internal-api-boundaries.md
    - Physics Methods: physics_methods.md
    - Neural Transport Training: neural_transport_training.md
    - Capacitor-Bank State Model: control/capacitor_bank_state.md
    - Multi-Shot Campaign: control/multi_shot_campaign.md
    - Runtime Admission: control/runtime_admission.md
    - Reactor Semantic Admission: control/reactor_semantic_admission.md
    - Reactor Regime Assessment Admission: control/reactor_regime_assessment_admission.md
    - Device Diagnostic Review Admission: control/device_diagnostic_review_admission.md
    - Pulsed Scenario Scheduler: control/pulsed_scenario_scheduler.md
    - Pulsed MPC Adapter: control/pulsed_mpc_adapter.md
    - AER Observation: scpn/aer_observation.md
    - Geometry-Neutral Replay: scpn/geometry_neutral_replay.md
    - Runtime-Bound Safety Certificate: scpn/runtime_safety_certificate.md
  - Validation:
    - Benchmarks: benchmarks.md
    - Fuzzing and Robustness: validation/fuzzing.md
    - Validation and QA: validation.md
    - Physics Traceability: physics_traceability.md
    - MAST Evidence:
      - Public Evidence Manifest: mast_evidence_manifest.md
      - Campaign Reconciliation: mast_campaign_reconciliation.md
      - Toroidal-Field Authority: mast_toroidal_field_authority.md
      - Normalised-Beta Authority: mast_normalised_beta_authority.md
      - Saddle-Modal Authority: mast_saddle_modal_authority.md
      - Locked-Mode Authority: mast_locked_mode_authority.md
      - dB/dt Source Authority: mast_dbdt_authority.md
    - Production Readiness: production_readiness.md
    - Known Limitations: known_limitations.md
    - Validation Summary: validation_summary.md
    - Validation Deficiencies: validation_deficiencies.md
    - Competitive Analysis: competitive_analysis.md
    - Deployment: deployment.md
  - Project:
    - JOSS Paper: joss_paper.md
    - Development: development.md
    - Git Path Exposure: history_exposure.md
    - Capability Manifest: capability_manifest.md
    - Capability Snapshot: _generated/capability_snapshot.md
    - Release Notes v0.23.0: release_notes_v0.23.0.md
    - Release Notes v0.22.1: release_notes_v0.22.1.md
    - Release Notes v0.22.0: release_notes_v0.22.0.md
    - Release Notes v0.21.0: release_notes_v0.21.0.md
    - Release Notes v0.20.7: release_notes_v0.20.7.md
    - Release Notes v0.20.6: release_notes_v0.20.6.md
    - Release Notes v0.20.5: release_notes_v0.20.5.md
    - Release Notes v0.20.4: release_notes_v0.20.4.md
    - Release Notes v0.20.3: release_notes_v0.20.3.md
    - Release Notes v0.20.2: release_notes_v0.20.2.md
    - Release Notes v0.20.1: release_notes_v0.20.1.md
    - Release Notes v0.20.0: release_notes_v0.20.0.md
    - Release Notes v0.19.3: release_notes_v0.19.3.md
    - Release Notes v0.19.2: release_notes_v0.19.2.md
    - Compute and Validation Collaboration: compute_validation_financing.md
    - Changelog: changelog.md
    - Pricing: pricing.md

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

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js