Cirrus is EPCC's Tier-2 High Performance Computing (HPC) cluster.
This repository contains the documentation for the service and is linked to a rendered version on ReadTheDocs.
For a guide on the rst file format see this document.
This documentation is drawn from the Sheffield Iceberg documentation and the ARCHER documentation.
Two versions of the documentation are currently automatically built from this repository:
To contribute to this documentation, first you have to fork it on GitHub and clone it to your machine, see Fork a Repo for the GitHub documentation on this process.
Once you have the git repository locally on your computer, you will need to install sphinx to be able to build the documentation. See the instructions below for how to achieve this.
Once you have made your changes and updated your Fork on GitHub you will need to Open a Pull Request.
Install the following:-
To build the HTML documentation run:
make html
If you want to build the PDF documentation you will need:
Then from the command line, the following will build the .pdf file
make latexpdf
On first run, MikTeX will prompt you to install various extra LaTeX packages.
Have
- Python 2
- sphinx
installed, then run
make html
For the HTML documentation you will need sphinx. If you do not already have a python distribution installed, we recommend you install Anaconda Python.
To build the HTML documentation run:
make html
The documentation consists of a series of reStructured Text files which have the .rst extension.
These files are then automatically converted to HTMl and combined into the web version of the documentation by sphinx.
It is important that when editing the files the syntax of the rst files is followed.
If there are any errors in your changes the build will fail and the documentation will not update, you can test your build locally by running make html.
The easiest way to learn what files should look like is to read the rst files already in the repository.