mkdocs.yml

# Copyright (c) 2020 Felix Soubelet <felix.soubelet@cern.ch>


# Project information
site_name: OMC Documentation
site_description: >-
  Documentation pages for the OMC Team at CERN. Content includes documentation
  on our activities, workflows and software as well as resources for members.
site_author: PyLHC/OMC-Team
site_url: https://pylhc.github.io
use_directory_urls: false 


# Repository
repo_name: 'PyLHC'
repo_url: 'https://github.com/pylhc'
edit_uri: 'pylhc.github.io/edit/master/docs/'


# Copyright
copyright: 'Copyright &copy; 2020 PyLHC/OMC-Team'


# Configuration
theme:
  name: 'material'
  custom_dir: overrides/
  logo: assets/logos/OMC_logo_inverse.svg  # top left header logo
  favicon: assets/logos/OMC_logo_inverse.svg  # browser tab logo
  # Default Values
  language: en
  features:
    - navigation.tabs
    - navigation.instant
    - content.action.edit  # editing button on the pages is opt-in since v9
  palette:
    scheme: preference
    primary: indigo
    accent: amber
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search
  - minify:
      minify_html: true


# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.keys:
      key_map: {"okbtn": "OK", "cancelbtn": "Cancel", "mousewheel": "Mouse Wheel"}
  - pymdownx.mark
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.tilde

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pylhc
      name: OMC's Organisation on Github
    - icon: fontawesome/solid/paper-plane
      link: mailto:OMC-team@cern.ch
      name: Email the OMC team

# Extras to load
extra_css:
  - css/extra.css
  - css/hint.min.css

extra_javascript:
  - javascripts/config.js
  - javascripts/mathjax-config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

# Site Layout
nav:
  - Home: index.md
  - OMC Team:
    - About: omc_team/about.md
    - Publications: omc_team/publications.md
    - Future MD Ideas: omc_team/ideas.md
    - ↪ On Mattermost: https://mattermost.web.cern.ch/be-dep/channels/omc-team
    - ↪ Meetings (Indico): https://indico.cern.ch/category/5986/
  - Python Ecosystem:
    - About: packages/about.md
    - omc3:
      - About omc3: packages/omc3/about.md
      - Getting Started: packages/omc3/getting_started.md
      - Analysis: packages/omc3/analysis.md
      - Know-How: packages/omc3/know_how.md
      - ↪ On Github: https://github.com/pylhc/omc3
    - PyLHC: 
      - About: packages/pylhc/about.md
      - Forced DA Analysis: packages/pylhc/forced_da.md
      - Machine Settings Info: packages/pylhc/machine_settings_info.md
      - BSRT Logger/Analysis: packages/pylhc/bsrt.md
      - BPM Calibration: packages/pylhc/bpm_calibration.md
      - Display Kickgroups: packages/pylhc/kickgroups.md
      - ↪ On Github: https://github.com/pylhc/PyLHC
    - PyLHC-Submitter: 
      - About: packages/pylhcsubmitter/about.md
      - Job Submitter: packages/pylhcsubmitter/job_submitter.md
      - AutoSix: packages/pylhcsubmitter/autosix.md
      - ↪ On Github: https://github.com/pylhc/submitter
    - IRNL Corrections: 
      - About: packages/irnl/about.md
      - ↪ On Github: https://github.com/pylhc/irnl_rdt_correction
    - MESS:
      - About: packages/mess/about.md
      - ↪ On Github: https://github.com/pylhc/MESS
    - Links to other Packages:
      - ↪ optics-functions: https://github.com/pylhc/optics_functions
      - ↪ Beta-Beat.src: https://github.com/pylhc/Beta-Beat.src
      - ↪ tfs-pandas: https://github.com/pylhc/tfs
      - ↪ sdds: https://github.com/pylhc/sdds
      - ↪ generic-parser: https://github.com/pylhc/generic_parser
    - Python Development: 
      - Contributing: packages/development/contributing.md
      - Virtual Environments: packages/development/howto_venv.md
      - Releases: packages/development/howto_release.md
  - GUIs:
    - The OMC GUIs: guis/about.md
    - Beta-Beat GUI:
      - About: guis/betabeat/gui.md
      - Beam Selection: guis/betabeat/beam_selection.md
      - BPM Panel: guis/betabeat/bpm_panel.md
      - Analysis Panel: guis/betabeat/analysis_panel.md
      - Optics Panel: guis/betabeat/optics_panel.md
      - Correction Panel: guis/betabeat/correction_panel.md
      - The omc3 branch: guis/betabeat/omc3.md
    - Kmod GUI:
      - About: guis/kmod/gui.md
      - Loading a Model: guis/kmod/load_model.md
      - Full IP Trim: guis/kmod/full_ip_trim.md
      - Magnet Modulation: guis/kmod/individual_modulation.md
      - Analyzing Trim Data: guis/kmod/trim_analysis.md
      - Using Auto Trim: guis/kmod/autotrim.md
    - Multiturn GUI:
        - About: guis/multiturn/gui.md
    - Developing the GUIs:
      - IDE Setup: guis/developing/ide_install.md
      - Releases: guis/developing/releases.md
      - KMod GUI hints: guis/developing/kmod_special.md
  - Measurements & Corrections:
    - Info: measurements/about.md
    - Physics and Methods:
      - Introduction: measurements/physics/about.md
      - Error Propagation: measurements/physics/error_propagation.md
      - BPM-Calibration: measurements/physics/bpm_calibration.md
      - Coupling: measurements/physics/coupling.md
      - K-Mod: measurements/physics/kmod.md
      - Linear IR Optics: measurements/physics/ir_linear_optics.md
      - Nonlinear IR Optics: measurements/physics/ir_nonlinear_optics.md
      - 3D-Kicks: measurements/physics/threedkicks.md
    - Procedures:
        - Info: measurements/procedures/about.md
        - General Checks: measurements/procedures/general_checks.md
        - K Modulation: measurements/procedures/kmod.md
        - Rigid Waist Shift: measurements/procedures/rigid_waist_shift.md
        - Amplitude Detuning: measurements/procedures/ampdet.md
        - Crossing Angle Scan: measurements/procedures/xing_scan.md
  - How To's:
    - Info: howto/about.md
    - General Setup: 
      - Git: howto/setup/git.md
      - GUIs: howto/setup/guis.md
      - Shared Filesystems: howto/setup/shared_filesystems.md
      - ↪ Virtual CentOS Machine: https://abpcomputing.web.cern.ch/guides/openstackCS8/
    - Teleworking: 
      - Remote Access: howto/teleworking/access.md
      - ↪ Tricks from IT: https://codimd.web.cern.ch/vjC8BHbTS7etHwJve-K2Uw
    - Wiki Pages: 
      - Editing this Wiki: howto/wiki/editing.md
      - ↪ CERN Docs: https://how-to.docs.cern.ch/
    - Other Relevant How To's:
      - ↪ ABPComputing: https://abpcomputing.web.cern.ch/
      - ↪ BBLumi: http://bblumi.web.cern.ch/utilities_tricks/
  - Resources:
      - Useful Links: resources/links.md
      - Computing: resources/computing.md
      - Publications: resources/publications.md
      - Presentations: resources/presentations.md
      - Logbook:
        - AD:
          - 2023: resources/logbook/2023_ad.md
          - 2024: resources/logbook/2024_ad.md
        - LEIR:
          - 2023: resources/logbook/2023_leir.md
          - 2024: resources/logbook/2024_leir.md
        - LHC: 
          - 2022: resources/logbook/2022_lhc.md
          - 2023: resources/logbook/2023_lhc.md
          - 2024: resources/logbook/2024_lhc.md
        - PS: 
          - 2023: resources/logbook/2023_ps.md
          - 2024: resources/logbook/2024_ps.md
        - PSB:
          - 2023: resources/logbook/2023_psb.md
          - 2024: resources/logbook/2024_psb.md
        - SPS:
          - 2023: resources/logbook/2023_sps.md
          - 2024: resources/logbook/2024_sps.md
      - Templates: resources/templates.md
      - FAQ: resources/faqs.md