A continuation of HPC Helper, now documenting ARCHER2, CSD3, and Cumulus. This repository builds upon the original HPC Helper, which was written for Sunbird.
- ARCHER2 – The UK's national supercomputing service.
- CSD3 – The Cambridge uni HPC cluster.
- Cumulus – hosted at the MDC data centre at the UKAEA.
- Friea - Very old, not used anymore. Hosted at UKAEA.
This docs is written on top of Jupyter book.
pip install -r requirements.txtjupyter-book build docs/jupyter-book build --all docs/ghp-import -n -p -f docs/_build/htmlI found PyData's sphinx theme to be much more useful for big projects. The structure of the theme is more complicated than the default jupyter book theme. Here is a nice documentation about the layout of the theme.
All we need to do is rearrange the TOC in _toc.yml. Each chapter will have its own index.md file as a lander. The sections will be the individual ipynb files. A small problem is I can't add caption to anything else other than Parts, so all the contents in a specific top bar will be continuous. There must be a way to do it, but I am too lazy to find it.
We also need to adjust the _config.yml. We need to make a number of changes. You can see my changes. Here is a list of all the possible changes and this is how PyData has implemented it.