Logo
latest

User Guide:

  • Quickstart
    • Dependencies
    • Installation
    • Testing
    • Basic Usage
    • Resources
  • Advanced Installation
    • pip
      • Installing with mpi4py
    • Conda
      • Installing with mpi4py with Conda
    • Spack
  • Understanding libEnsemble
    • Overview
    • Example Use Cases
    • Glossary
  • Programming with libEnsemble
    • Main libE Module - Calling Script
    • Output Management
      • Default Log Files
      • Logger Configuration
      • Working Directories for User Functions
    • Data Structures
      • sim_specs
      • gen_specs
      • alloc_specs
      • libE_specs
      • persis_info
      • exit_criteria
      • history array
      • worker array
      • work dictionary
      • calc_status
    • User Function API
      • sim_f API
      • gen_f API
      • alloc_f API
    • Writing User Functions
      • Generator Functions
      • Simulator Functions
      • Allocation Functions
    • Executor
      • Executor Overview
      • Executor Modules
    • Resource Manager
      • Dynamic Assignment of Resources
      • 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
  • Running libEnsemble
    • MPI Comms
      • Limitations of MPI mode
    • Local Comms
      • Limitations of local mode
    • TCP Comms
      • Limitations of TCP mode
    • Persistent Workers
    • Environment Variables
    • Further run information
  • Running on HPC Systems
    • Central v Distributed
    • Configuring the Run
    • Systems with Launch/MOM nodes
    • Mapping Tasks to Resources
      • Zero-resource workers
    • Overriding Auto-detection
    • funcX - Remote User functions
    • Instructions for Specific Platforms
      • Bebop
      • Cori
      • Theta
      • Summit
      • Example libEnsemble Submission Scripts

Tutorials:

  • Multiprocessing with a Simple Sine
    • Getting started
    • Generator function
    • Simulator function
    • Calling script
    • Next steps
      • libEnsemble with MPI
      • Modifying the calling script
  • Executor with Electrostatic Forces
    • Getting Started
    • Calling Script
    • Simulation Function
    • Executor Variants
  • 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
  • Example User Functions and Calling Scripts
    • Generation Functions
      • sampling
      • persistent_uniform_sampling
      • APOSMM
      • uniform_or_localopt
      • persistent_deap_nsga2
      • persistent_tasmanian
      • persistent_fd_param_finder
      • persistent_surmise
    • Simulation Functions
      • six_hump_camel
      • chwirut
      • noisy_vector_mapping
      • periodic_func
      • borehole
      • executor_hworld
    • Allocation Functions
      • give_sim_work_first
      • fast_alloc
      • fast_alloc_to_aposmm
      • start_only_persistent
      • start_persistent_local_opt_gens
    • Calling Scripts
      • Local Sine Tutorial
      • Electrostatic Forces with Executor
      • Persistent APOSMM with Gradients

Additional References:

  • Frequently Asked Questions
    • Common Errors
    • HPC Errors and Questions
    • libEnsemble Help
    • macOS-Specific Errors
  • Known Issues
  • Release Notes
    • 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
    • SciPy 2020 Virtual Poster
      • libEnsemble: A Python Library for Dynamic Ensemble-Based Computations
    • SciPy 2020 PDF Poster
    • CSE 2019 Poster

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
    • Worker Module
      • libEnsemble worker class
    • History Module
    • Resources Module
    • RSET Resources Module
    • Worker Resources Module
    • Environment Resources Module
    • Node Resources Module
    • MPI Resources Module
    • Scheduler Module
libEnsemble
  • »
  • Example User Functions and Calling Scripts
  • Edit on GitHub

Example User Functions and Calling Scripts

Here we give example generation, simulation, and allocation functions for libEnsemble, as well as example calling scripts.

libEnsemble Example Functions:

  • Generation Functions
    • sampling
    • persistent_uniform_sampling
    • APOSMM
    • uniform_or_localopt
    • persistent_deap_nsga2
    • persistent_tasmanian
    • persistent_fd_param_finder
    • persistent_surmise
  • Simulation Functions
    • six_hump_camel
    • chwirut
    • noisy_vector_mapping
    • periodic_func
    • borehole
    • executor_hworld
  • Allocation Functions
    • give_sim_work_first
    • fast_alloc
    • fast_alloc_to_aposmm
    • start_only_persistent
    • start_persistent_local_opt_gens
  • Calling Scripts
    • Local Sine Tutorial
    • Electrostatic Forces with Executor
    • Persistent APOSMM with Gradients
Previous Next

© Copyright 2022 Argonne National Laboratory. Revision b5a69cad.

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