JohnMulligan/rice-hpc-docs

Documentation for the HPC Resources at Rice University

This repository is out of date and no longer maintained. Please visit https://researchcomputing.rice.edu/ for documentation regarding documentation for CRC and HPC resources at Rice University.

Rice CRC Documentation

Documentation for the CRC and HPC Resources at Rice University. The documentation is written in reStructuredText format and rendered to HTML using the Sphinx documentation engine.

Install and Build

To install the needed dependencies using the Anaconda Python distribution, run

> conda env create -f environment.yml
> source activate hpc-docs

inside this repository. Alternatively, download all of the packages in environment.yml using pip. Then, build the HTML documentation using

> make html

The documentation homepage will be in _build/html/index.html.

Helpful Links

Here are some other resources and examples of nicely formatted HPC documentation:

• Sheffield HPC Docs
• UiT HPC Docs
• Python for HPC Help