Python API

Flux provides a rich Python interface. With few exceptions, any Flux interactions that are possible in C or on the command line are possible in Python as well via the flux package.

Contents:

• Flux Python Basics
  • Importing the flux Python package
  • The Flux class
  • The Flux reactor
• Flux Job Submission and Monitoring
  • Job submission
  • Job manipulation
  • Synchronous interface
  • Asynchronous interfaces
• Python Broker Modules
  • Loading a Python module
  • The mod_main entry point
  • Using BrokerModule
  • Logging
  • Error handling
  • Module arguments
  • API reference
• Writing a Python Scheduler
  • Minimal example
  • The resource pool
  • Alloc requests
  • Override points
  • Queue depth
  • Scheduling deferral
  • Forecast deferral
  • Module arguments
  • Logging
  • Statistics
  • Testing
  • Customizing the resource pool
  • The R.scheduling key
  • API reference
• Complete API Reference
  • flux package
• Flux Python Development
  • Development Environment
  • Linting
  • Writing Python Commands

Indices and tables

• Index

• Module Index

• Search Page