HKUST HPC Documentation

Searchable doc at readthedocs.io.

Tutorials, docs and knowledge base for AI / HPC users using central HPC resources at the Hong Kong University of Science and Technology (HKUST).

Despite this doc is tailored for Superpod and HPC4 maintained by Information Technology Services Center (ITSO), you may find some useful techniques in general and works on other HPC systems as well.

Building the Documentation

To build the documentation locally, first set up the development environment by following the contributor’s guide.

Once set up, you can build the HTML pages by running:

make

The output will be located in the build/html directory.

Acknowledgement

Courtesy to readthedocs.com for providing free hosting for open-source documentations.

Contributors

We very much appreciate contributions to this doc in all forms including but not limited to:

  • Reporting issues or suggestions

  • Requesting new topics to be discussed

  • Submitting corrections or improvements via pull requests

  • Sharing your experience or knowledge in articles

To contribute, please refer to the contributor’s guide.

License

This project is licensed under the MIT License.