Logo

User Guide:

  • Quickstart
  • Advanced Installation
  • Understanding libEnsemble
  • Constructing Workflows
    • Running an Ensemble
    • Configuring libEnsemble
    • Output Management
    • History Array
    • Resource Manager
    • Writing User Functions
    • Executors
    • Convenience Tools and Functions
  • Running libEnsemble
  • Running on HPC Systems

Tutorials:

  • Simple Introduction
  • Ensemble with an MPI Application
  • Executor - Assign GPUs
  • Surrogate Modeling with gpCAM
  • Optimization with APOSMM
  • Calibration with Simulation Cancellation
  • Bayesian Optimization with Xopt

Examples:

  • (New) Standardized Generators
  • Generator Functions
  • Simulation Functions
  • Allocation Functions
  • Calling Scripts
  • Submission Scripts

Additional References:

  • Frequently Asked Questions
  • Known Issues
  • Release Notes
  • Contributing to libEnsemble
  • Posters and Presentations

Developer Guide:

  • Release Management
  • Internal Modules
libEnsemble
  • Constructing Workflows
  • View page source

Constructing Workflows

We now give greater detail in programming with libEnsemble.

The Basics

  • Running an Ensemble
    • Ensemble
  • Configuring libEnsemble
    • LibE Specs
    • Generator Specs
    • Simulation Specs
    • Allocation Specs
    • Platform Specs
    • persis_info
    • Exit Criteria
  • Output Management
    • Simulation Directories
    • Default Log Files
    • Logger Configuration
    • Analysis Utilities
  • History Array
    • Overview
    • Reserved Fields
    • Example Workflow updating History
  • Resource Manager
    • Zero-resource workers (e.g., Persistent gen does not need resources)
    • Dynamic Assignment of Resources
    • Resource Detection
    • Scheduler Module
    • Worker Resources Module (query resources for current worker)

Writing User Functions:

  • Writing User Functions
    • Generator Functions
    • Ask/Tell Generators
    • Simulator Functions
    • Allocation Functions
    • User Function API
    • calc_status
    • Work Dictionary
    • Worker Array

Coordinating Apps

  • Executors
    • Executor Overview
    • Base Executor - Local apps
    • MPI Executor - MPI apps

Helpful Additions

  • Convenience Tools and Functions
    • add_unique_random_streams()
    • check_npy_file_exists()
    • eprint()
    • ForkablePdb
    • parse_args()
    • save_libE_output()
    • PersistentSupport
    • AllocException
    • AllocSupport
Previous Next

© Copyright 2026 Argonne National Laboratory.

Built with Sphinx using a theme provided by Read the Docs.