hpc/mkdocs.yml at main · amrltu/hpc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
site_name: Tribhuvan University's Super Computer (HPC)
repo_url: https://github.com/amrltu/hpc-tu.github.io
edit_uri: edit/main/docs/
site_url: https://hpc-tu.github.io/

theme:
  name: material
  favicon: assets/img/logo2.png

  # Option for Footer
  features:
    - navigation.footer
    - navigation.path
    # - navigation.tabs
    #- search.highlight
    #- search.share

  #color pallate for light and dark
  palette:
    - primary: blue
    - accent: red
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode

nav:
  - Home: index.md
  - About HPC:
      - Introduction: about/introduction.md
      - Mission & Objectives: about/mission.md
      - Research Applications: about/research.md
      - HPC Team: about/team.md
  - HPC Resources:
      - Compute Infrastructure: resources/compute.md
      - Storage Details: resources/storage.md
      - Network & Security: resources/network.md
      - Software & Tools: resources/software.md
  - Access & Accounts:
      - Who Can Access?: access/who_can_access.md
      - Account Registration: access/registration.md
      - User Roles & Permissions: access/roles.md
      - Security Guidelines: access/security.md
  - Getting Started:
      - SSH Access: getting_started/ssh.md
      - Running First Job: getting_started/first_job.md
      - File Transfers: getting_started/file_transfer.md
      - Best Practices: getting_started/best_practices.md
  - Job Scheduling & SLURM:
      - SLURM Basics: slurm/basics.md
      - Submitting Jobs: slurm/submitting.md
      - Monitoring Jobs: slurm/monitoring.md
      - SLURM Partitions: slurm/partitions.md
      - Debugging Jobs: slurm/debugging.md
  - Software & Modules:
      - Available Software: software/available.md
      - Using Modules: software/modules.md
      - Installing Software: software/installing.md
      - AI/ML & Quantum Computing: software/ai_ml.md
  - Data Storage & Management:
      - HPC Storage System: storage/system.md
      - Data Backup & Archiving: storage/backup.md
      - File System Quotas: storage/quotas.md
  - Parallel Computing & Optimization:
      - MPI & OpenMP: parallel/mpi_openmp.md
      - GPU Acceleration: parallel/gpu.md
      - Performance Optimization: parallel/optimization.md
  - Tutorials & Documentation:
      - HPC User Guides: tutorials/guides.md
      - Step-by-Step Tutorials: tutorials/step_by_step.md
      - Training Materials: tutorials/training.md
  - Research & Case Studies:
      - Success Stories: research/success.md
      - Featured Projects: research/projects.md
      - Publications & Papers: research/publications.md
  - User Support & Policies:
      - Helpdesk & Support: support/helpdesk.md
      - FAQs: support/faqs.md
      - HPC Policies: support/policies.md
  - Contact & Feedback:
      - Contact HPC Team: contact/team.md
      - Reporting Issues: contact/issues.md
      - Training Events: contact/training.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.highlight
  - pymdownx.details