ICHEC National Service Docs

This repository contains the source of the documentation for ICHEC's national computational service platforms, which include access to supercomputing resources, support on softwares, and help pages for running simulations.

If you find something worth adding, or mistakes in the content, please see the CONTRIBUTING page to make suggestion or contribution.

Structure of the source

This website is created using Jupyterbook, based on sphinx. See the Jupyterbook for more details. The source for this website uses MyST Markdown.

The structure of the files looks like follows -

(web) 👽 618-rajarshi 0 (main)✗  tree .
.
├── README.md
├── _config.yml
├── _static
│   └── style.css
├── _toc.yml
├── contact-us.md
├── index.md
├── interim-service.md
├── logo.png
├── lxp
│   └── introduction.md
├── national-hpc-service.md
├── references.bib
├── requirements.txt
└── scratch.md
...

There are three types of files -

1. YAML files, with extension .yml which are used to define structure and build process of the pages. _config.yml file defines all the configurational options for building the pages, and _toc.yml file defines the table of contents, and structure of the documents.

2. CSS files, primarily stored in _static folder, and define the appearance settings for the webpages.

3. Markdown files, with .md extension. These are primarily ones that contain the documentation information. Jupyterbook follows MyST format, which is quite feature rich for building pages and pdfs of the technical documents. Checkout the MyST features here.