CoSTAR Cluster User Documentation
=================================

Welcome to the official user documentation for the CoSTAR cluster.


Popular pages
-------------



.. grid:: 1 1 2 2
    :class-row: surface
    :gutter: 3
    :padding: 0

    .. grid-item-card:: :octicon:`terminal` Getting Started
        :link: start/index
        :link-type: doc

        Connect to the cluster, set up SSH keys, and first steps for new users.

    .. grid-item-card:: :octicon:`code-square` Example Scripts
        :link: tutorials/examples/index
        :link-type: doc

        Worked examples for first jobs, Slurm scripts, and containerised workflows.

    .. grid-item-card:: :octicon:`browser` Interactive Sessions
        :link: cluster/software/ood
        :link-type: doc

        For browser-based interactive work with tools such as JupyterLab and VS Code, check out Open OnDemand.

    .. grid-item-card:: :octicon:`server` Job Submission
        :link: cluster/scheduler/index
        :link-type: doc

        Write batch scripts, request CPUs, GPUs, memory, and wall time, and
        monitor jobs through Slurm.

    .. grid-item-card:: :octicon:`rocket` Available Support
        :link: available-support
        :link-type: ref

        Find out where to get help, what support is available, and how to report
        issues with the service.

    .. grid-item-card:: :octicon:`mail` Ticket System
        :link: support-tickets
        :link-type: ref

        Submit useful support tickets with the information needed to diagnose
        access, software, job, or storage problems.

    .. grid-item-card:: :octicon:`database` Data & Storage
        :link: cluster/storage/index
        :link-type: doc

        Understand home, project, and scratch storage, including quotas and
        recommended locations for datasets and outputs.

    .. grid-item-card:: :octicon:`mortar-board` Self-guided Onboarding Course
       :link: tutorials-onboarding-index
       :link-type: ref

       A step-by-step introduction to the CoSTAR high performance computing cluster for beginners.


.. toctree::
   :hidden:
   :caption: Start
   :titlesonly:

   start/index
   start/login
   start/ssh/index
   start/usage_policy

.. toctree::
   :hidden:
   :caption: Help
   :maxdepth: 2
   :titlesonly:

   help/index
   help/tickets
   help/faq

.. toctree::
   :caption: The Cluster
   :hidden:
   :maxdepth: 2
   :titlesonly:

   cluster/index
   cluster/software/index
   cluster/scheduler/index
   cluster/storage/index

.. toctree::
   :caption: Tutorials & Training
   :hidden:
   :maxdepth: 1
   :titlesonly:

   tutorials/examples/index
   tutorials/guides/index
   tutorials/onboarding/index

.. toctree::
   :caption: About
   :hidden:
   :maxdepth: 2
   :titlesonly:

   about/index
   about/acknowledgements

.. toctree::
   :hidden:
   :caption: Links
   :maxdepth: 1

   CoSTAR Network <https://www.costarnetwork.co.uk/>