index.rst

Welcome to Flux's documentation!

Flux is a flexible framework for resource management, built for your site. The framework consists of a suite of projects, tools, and libraries which may be used to build site-custom resource managers for High Performance Computing centers.

.. toctree::
   :maxdepth: 3
   :caption: Contents

   quickstart
   adminguide
   contributing
   debugging
   batch
   hierarchies
   coral
   coral2
   faqs
   stats

.. toctree::
   :maxdepth: 1
   :caption: Sub-Projects
   :hidden:

   flux-core <https://flux-framework.readthedocs.io/projects/flux-core/en/latest/index.html>
   flux-sched <https://flux-framework.readthedocs.io/projects/flux-sched/en/latest/index.html>
   flux-security <https://flux-framework.readthedocs.io/projects/flux-security/en/latest/index.html>
   RFCs <https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/index.html>
   Workflow Examples <https://flux-framework.readthedocs.io/projects/flux-workflow-examples/en/latest/index.html>

Contributor Relevant RFCs

• :doc:`rfc:spec_1`
• :doc:`rfc:spec_2`
• :doc:`rfc:spec_7`
• :doc:`rfc:spec_9`

All RFCs

• :doc:`rfc:index`

Manual Pages

• :ref:`core:man-pages`
• :ref:`sched:man-pages`
• :ref:`security:man-pages`

Workflow Examples

• :doc:`workflow-examples:index`

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`