Programming with libEnsemble

We now give greater detail in programming with libEnsemble.

• Main libE Module - Calling Script
• Output Management
  • Default Log Files
  • Logger Configuration
  • Working Directories for User Functions
    • Timing analysis scripts
    • Results analysis scripts
    • Balsam analysis scripts
• Data Structures
  • history array
    • Overview
    • Reserved fields in history array
    • Example workflow updating history array
  • sim_specs
  • gen_specs
  • alloc_specs
  • libE_specs
    • Scheduler Options
    • Overriding Resource Auto-Detection
  • persis_info
  • exit_criteria
  • worker array
  • work dictionary
  • calc_status

libEnsemble User Functions:

• User Function API
  • sim_f API
    • Parameters:
    • Returns:
  • gen_f API
    • Parameters:
    • Returns:
  • alloc_f API
    • Parameters:
    • Returns:
• Writing User Functions
  • Generator Functions
    • Persistent Generators
    • Active receive mode
    • Cancelling Simulations
    • Generator initiated shutdown
    • Examples
  • Simulator Functions
    • Executor
    • Persistent Simulators
  • Allocation Functions

• Executors
  • Executor Overview
  • Base Executor - Local apps
    • MPI Executor - MPI apps
      • Class-specific Attributes
    • Legacy Balsam MPI Executor
    • Balsam Executor - Remote apps
    • Executor Class
    • Task Class
    • Task Attributes
  • MPI Executor - MPI apps
    • Class-specific Attributes
  • Legacy Balsam MPI Executor
  • Balsam Executor - Remote apps
• Resource Manager
  • Dynamic Assignment of Resources
    • Overview
    • Variable resource assignment
      • Variable Size simulations
      • Accessing resources from the simulation function
      • Resource Scheduler Options
      • Varying generator resources
    • Example scenarios
      • Persistent generator
      • Using large resource sets
      • Setting more resource sets than workers
  • Resource Detection
  • Zero-resource workers
  • Scheduler Module
  • Worker Resources Module

• Convenience Tools and Functions
  • Calling Script Function Support
  • Persistent Function Support
  • Allocation Function Support
  • Consensus Subroutines