Logo
latest

User Guide:

  • Quickstart
    • Installation
    • Resources
    • Basic Usage
      • Select or supply Simulator and Generator functions
      • Launch and monitor apps on parallel resources
  • Advanced Installation
    • pip
      • Installing with mpi4py
    • Conda
      • Installing with mpi4py with Conda
    • Spack
  • Understanding libEnsemble
    • Overview
    • Example Use Cases
    • Glossary
  • Constructing Workflows
    • Running an Ensemble
      • Ensemble
      • libE()
    • Configuring libEnsemble
      • Simulation Specs
      • Generator Specs
      • General Specs
      • Allocation Specs
      • persis_info
      • Exit Criteria
    • Output Management
      • Default Log Files
      • Logger Configuration
    • Writing User Functions
      • Generator Functions
      • Simulator Functions
      • Allocation Functions
      • User Function API
      • calc_status
      • Work Dictionary
      • Worker Array
    • History Array
      • Overview
      • Reserved Fields
      • Example Workflow updating History
    • Executors
      • Executor Overview
      • Base Executor - Local apps
      • MPI Executor - MPI apps
      • Balsam Executor - Remote apps
    • 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)
    • Convenience Tools and Functions
      • Calling Script Function Support
      • Persistent Function Support
      • Allocation Function Support
  • Running libEnsemble
    • MPI Comms
      • Limitations of MPI mode
    • Local Comms
      • Limitations of local mode
    • TCP Comms
      • Reverse-ssh interface
      • Limitations of TCP mode
    • Further command line options
    • liberegister / libesubmit
    • Persistent Workers
    • Environment Variables
    • Further run information
  • Running on HPC Systems
    • Central v Distributed
    • Configuring the Run
    • Systems with Launch/MOM nodes
    • Balsam - Externally managed applications
    • Mapping Tasks to Resources
      • Zero-resource workers
    • Overriding Auto-detection
    • funcX - Remote User functions
    • Instructions for Specific Platforms
      • Bebop
      • Frontier
      • Perlmutter
      • Polaris
      • spock/crusher
      • Summit
      • Theta
      • libEnsemble with SLURM
      • Example libEnsemble Submission Scripts

Tutorials:

  • Multiprocessing with a Simple Sine
    • Getting started
    • Generator function
      • Exercise
    • Simulator function
      • Exercise
    • Calling Script
      • Exercise
    • Next steps
      • libEnsemble with MPI
      • Modifying the calling script
  • Executor with Electrostatic Forces
    • Getting Started
    • Calling Script
      • Exercise
    • Simulation Function
      • Exercises
  • Executor - Assign GPUs
    • Simulation function
    • Compiling the Forces application
    • Running the example
    • Changing the number of GPUs per worker
    • Varying resources
    • Checking GPU usage
    • Example submission script
  • Parallel Optimization with APOSMM
    • Six-Hump Camel Simulation Function
    • APOSMM Operations
    • APOSMM Persistence
    • Calling Script
    • Final Setup, Run, and Output
    • Applications
  • Borehole Calibration with Selective Simulation Cancellation
    • Introduction - Calibration with libEnsemble and a Regression Model
    • Overview of the Calibration Problem
    • Point Cancellation Requests and Dedicated Fields
    • Allocation function
    • Calling Script - Reading Results
    • Using cancellations to kill running simulations

Examples:

  • Generator Functions
    • sampling
      • uniform_random_sample()
      • uniform_random_sample_with_variable_resources()
      • uniform_random_sample_with_var_priorities_and_resources()
      • uniform_random_sample_obj_components()
      • latin_hypercube_sample()
      • uniform_random_sample_cancel()
    • persistent_sampling
      • persistent_uniform()
      • persistent_request_shutdown()
      • uniform_nonblocking()
      • batched_history_matching()
      • persistent_uniform_with_cancellations()
    • persistent_sampling_var_resources
      • uniform_sample()
      • uniform_sample_with_procs_gpus()
      • uniform_sample_with_var_priorities()
      • uniform_sample_diff_simulations()
    • APOSMM
      • Configuring APOSMM
      • Persistent APOSMM
      • LocalOptInterfacer
    • uniform_or_localopt
      • uniform_or_localopt()
    • persistent_tasmanian
      • lex_le()
      • get_2D_insert_indices()
      • get_2D_duplicate_indices()
      • get_state()
      • get_H0()
      • sparse_grid_batched()
      • sparse_grid_async()
      • get_sparse_grid_specs()
    • persistent_fd_param_finder
      • fd_param_finder()
    • persistent_surmise
      • surmise_calib()
  • Simulation Functions
    • six_hump_camel
      • six_hump_camel()
      • six_hump_camel_simple()
      • persistent_six_hump_camel()
    • chwirut
      • chwirut_eval()
    • noisy_vector_mapping
      • func_wrapper()
      • noisy_function()
    • periodic_func
      • func_wrapper()
      • periodic_func()
    • borehole
      • borehole()
      • borehole_func()
      • gen_borehole_input()
    • executor_hworld
      • executor_hworld()
  • Allocation Functions
    • give_sim_work_first
      • give_sim_work_first()
    • fast_alloc
      • give_sim_work_first()
    • start_only_persistent
      • only_persistent_gens()
      • only_persistent_workers()
    • start_persistent_local_opt_gens
      • start_persistent_local_opt_gens()
  • Calling Scripts
    • Local Sine Tutorial
    • Electrostatic Forces with Executor
      • Traditional Version
      • Object + yaml Version
    • Persistent APOSMM with Gradients

Additional References:

  • Frequently Asked Questions
    • Common Errors
    • HPC Errors and Questions
    • libEnsemble Help
    • macOS and Windows Errors
  • Known Issues
  • Release Notes
    • Release 0.9.3
    • Release 0.9.2
    • Release 0.9.1
    • Release 0.9.0
    • Release 0.8.0
    • Release 0.7.2
    • Release 0.7.1
    • Release 0.7.0
    • Release 0.6.0
    • Release 0.5.2
    • Release 0.5.1
    • Release 0.5.0
    • Release 0.4.1
    • Release 0.4.0
    • Release 0.3.0
    • Release 0.2.0
    • Release 0.1.0
  • Contributing to libEnsemble
  • Posters and Presentations
    • Exascale Computing Project 2023
    • SciPy 2020
    • CSE 2019

Developer Guide:

  • Release Management for libEnsemble
    • Release Process
      • Before release
      • During release
      • After release
    • Release Platforms
      • GitHub release
      • PyPI release
      • Conda release
      • Spack release
  • libEnsemble Internal Modules
    • Manager Module
      • libEnsemble manager routines
      • manager_main()
      • Manager
    • Worker Module
      • libEnsemble worker class
      • worker_main()
      • Worker
    • History Module
      • History
    • Resources Module
      • Resources
      • GlobalResources
    • RSET Resources Module
      • RSetResources
    • Worker Resources Module
      • ResourceManager
      • WorkerResources
    • Environment Resources Module
      • EnvResources
    • Node Resources Module
      • get_cpu_cores()
      • get_sub_node_resources()
    • MPI Resources Module
      • MPIResourcesException
      • get_MPI_variant()
      • get_MPI_runner()
      • task_partition()
      • get_resources()
      • create_machinefile()
      • get_hostlist()
    • Scheduler Module
libEnsemble
  • libEnsemble Internal Modules
  • Edit on GitHub

libEnsemble Internal Modules

This section documents the internal modules of libEnsemble.

Modules:

  • Manager Module
  • Worker Module
  • History Module
  • Resources Module
  • RSET Resources Module
  • Worker Resources Module
  • Environment Resources Module
  • Node Resources Module
  • MPI Resources Module
  • Scheduler Module
Previous Next

© Copyright 2023 Argonne National Laboratory. Revision 10f02627.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
main
docs-simplify_executor_tutorial
develop
Downloads
pdf
On Read the Docs
Project Home
Builds