Flux tutorials and documentation

Most Flux commands and their options are described in their respective man pages, which can be accessed via the man command or via flux help. For example, man flux-mini or flux help mini will describe the options for the various flux mini commands.

The primary source for more general Flux documentation is the Flux readthedocs page. There, you will find documentation on everything from getting started with Flux to batch jobs to administering Flux on clusters. There are also a number of usage examples, descriptions of the commands and python bindings, and API and other specifications.

Finally, the Flux developers are very active in the HPC community and have made slides from various tutorials that they have given available on GitHub.

If you reference Flux in a published paper, please use:
Dong H. Ahn, Ned Bass, Albert Chu, Jim Garlick, Mark Grondona, Stephen Herbein, Joseph Koning, Tapasya Patki, Thomas R. W. Scogland, Becky Springmeyer, and Michela Taufer. 2018. Flux: Overcoming Scheduling Challenges for Exascale Workflows. In 2018 IEEE/ACM Workflows in Support of Large-Scale Science (WORKS). IEEE, Dallas, TX, USA, 10–19.

Appendix 1 | Appendix 2 | Appendix 3
Back to index