mkdocs.yml

theme:
  name: material
  favicon: favicon.ico
  logo: images/cirrus_logo_white-Transparent-Background.png
  palette:
    primary: teal
    accent:  teal
  features:
    - tabs
  icon:
    repo: fontawesome/brands/github

extra_css:  [stylesheets/cirrus.css]

site_name: Cirrus User Documentation
repo_url: https://github.com/EPCCed/cirrus-docs
repo_name: EPCCed/cirrus-docs
edit_uri: edit/main/docs/
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EPCCed
  analytics:
    provider: google
    property: 
  analytics:
    provider: google
    property: G-3T9RVR5FTP

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - "Overview": index.md
  - "Cirrus migration to E1000 system": e1000-migration
  - "User Guide":
    - "Introduction": user-guide/introduction.md
    - "Connecting to Cirrus": user-guide/connecting.md
    - "Data Management and Transfer": user-guide/data.md
    - "File and Resource Management": user-guide/resource_management.md
    - "Application Development Environment": user-guide/development.md
    - "Running Jobs on Cirrus": user-guide/batch.md
    - "Singularity Containers": user-guide/singularity.md
    - "Using Python": user-guide/python.md
    - "Using the Cirrus GPU Nodes": user-guide/gpu.md
    - "Solid state storage": user-guide/solidstate.md
  - "Software Applications":
    - "Castep": software-packages/castep.md
    - "CP2K": software-packages/cp2k.md
    - "ELEMENTS": software-packages/elements.md
    - "FLACS": software-packages/flacs.md
    - "Gaussian": software-packages/gaussian.md
    - "GROMACS": software-packages/gromacs.md
    - "HELYX®": software-packages/helyx.md
    - "LAMMPS": software-packages/lammps.md
    - "MATLAB": software-packages/MATLAB.md
    - "NAMD": software-packages/namd.md
    - "OpenFOAM": software-packages/openfoam.md
    - "ORCA": software-packages/orca.md
    - "Quantum Espresso (QE)": software-packages/qe.md
    - "STAR-CCM+": software-packages/starccm+.md
    - "VASP": software-packages/vasp.md
  - "Software Libraries":
    - "Intel MKL: BLAS, LAPACK, ScaLAPACK": software-libraries/intel_mkl.md
    - "HDF5": software-libraries/hdf5.md
  - "Software Tools":
    - "Linaro Forge": software-tools/forge.md
    - "Profiling using Scalasca": software-tools/scalasca.md
    - "Intel VTune": software-tools/intel-vtune.md
  - "References and further reading": user-guide/reading.md