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.

Contents

• Quick Start
  • Building the Code
    • Spack: Recommended for curious users
    • Docker: Recommended for quick, single-node deployments
    • Manual Installation: Recommended for developers and contributors
  • Starting a Flux Instance
  • Interacting with a Flux Session
  • Flux KVS
  • Launching Work in a Flux Session
• Flux Administrator’s Guide
  • Installation
    • Prerequisites
    • Package installation
    • System instance CURVE Keys
  • System Instance Configuration
    • flux-security config
    • Execution system configuration
    • Instance access configuration
    • Overlay network configuration
    • Resource exclusion
    • Storage configuration
  • System Instance Administration
    • Starting Flux
    • Stopping Flux
    • Changing the Flux configuration
    • Draining Resources
    • Managing the Flux Queue
    • Managing Flux Jobs
    • Dedicated Application Time
    • Updating Flux Software
  • Troubleshooting
    • Logs
• Contributing
  • Pull Requests
  • Developer Guidelines
• CORAL Systems
  • Launching Flux
  • Launching Spectrum MPI within Flux
  • Scheduling GPUs
• Debugging Jobs
  • Parallel Debugging using TotalView
  • Better Handling of Flux’s Internal Exec Events
  • Known Issues
• Batch Jobs
  • Launching Flux in Interactive Mode
  • Mini Batch Command
  • Launching Flux in SLURM’s Batch Mode
  • Blocking and Non-blocking Commands
  • Fluxion Scheduler
• FAQs
  • Does flux run on a mac?
  • How do I report a bug?
  • Why is Flux not discovering and managing all of the resources on the system/node?
  • How do I efficiently launch a large number of jobs to Flux?
  • Memory exhaustion on a node when running large ensembles with Flux
  • How do I mimic Slurm’s job step semantics ?
  • Flux is failing to bootstrap a specific MPI implementation (e.g. OpenMPI, MPICH, Spectrum MPI)
  • My message callback is not being run. How do I debug?
  • I’m experiencing a hang while running my parallel application. How can I debug?
  • How does the versioning of Flux work with its multi-repo structure?

Contributor Relevant RFCs

• 1/C4.1 - Collective Code Construction Contract
• 2/Flux Licensing and Collaboration Guidelines
• 7/Flux Coding Style Guide
• 9/Distributed Communication and Synchronization Best Practices

Command Reference

• Welcome to flux-core's documentation!

API Reference

• Flux RFC Index

Indices and tables

• Index
• Module Index
• Search Page