main
User Guide:
Quickstart
Advanced Installation
Understanding libEnsemble
Constructing Workflows
Running libEnsemble
Running on HPC Systems
Tutorials:
Simple Introduction
Executor with Electrostatic Forces
Executor - Assign GPUs
Optimization with APOSMM
Calibration with Simulation Cancellation
Examples:
Generator Functions
Simulation Functions
Allocation Functions
Calling Scripts
Additional References:
Frequently Asked Questions
Known Issues
Release Notes
Contributing to libEnsemble
Posters and Presentations
Developer Guide:
Release Management
Internal Modules
libEnsemble
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
Z
_
__init__() (env_resources.EnvResources method)
(libensemble.executors.balsam_executor.BalsamExecutor method)
(libensemble.executors.executor.Executor method)
(libensemble.history.History method)
(libensemble.tools.alloc_support.AllocSupport method)
(manager.Manager method)
(resources.resources.GlobalResources method)
(resources.resources.Resources method)
(resources.scheduler.ResourceScheduler method)
(resources.worker_resources.ResourceManager method)
(resources.worker_resources.WorkerResources method)
(rset_resources.RSetResources method)
(worker.Worker method)
A
abbrev_nodenames() (env_resources.EnvResources static method)
abort_on_exception (libensemble.specs.LibeSpecs attribute)
add_comm_info() (resources.resources.GlobalResources method)
(resources.resources.Resources method)
add_random_streams() (libensemble.ensemble.Ensemble method)
add_unique_random_streams() (in module tools)
all_gen_informed() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
all_sim_ended() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
all_sim_started() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
alloc_f (libensemble.specs.AllocSpecs attribute)
alloc_support
module
AllocException
AllocSupport (class in alloc_support)
(class in libensemble.tools.alloc_support)
aposmm() (in module persistent_aposmm)
aposmm_localopt_support
module
assign_resources() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
(resources.scheduler.ResourceScheduler method)
assign_rsets() (resources.worker_resources.ResourceManager method)
authkey (libensemble.specs.LibeSpecs attribute)
avail_worker_ids() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
B
BalsamExecutor (class in libensemble.executors.balsam_executor)
BalsamTask (class in libensemble.executors.balsam_executor)
batched_history_matching() (in module persistent_sampling)
best_split() (rset_resources.RSetResources static method)
borehole
module
borehole() (in module borehole)
borehole_func() (in module borehole)
C
calc_dir_id_width (libensemble.specs.LibeSpecs attribute)
cancel() (libensemble.executors.executor.Task method)
cancelled() (libensemble.executors.executor.Task method)
chwirut1
module
chwirut_eval() (in module chwirut1)
close() (aposmm_localopt_support.LocalOptInterfacer method)
cobalt_abbrev_nodenames() (env_resources.EnvResources static method)
comms (libensemble.specs.LibeSpecs attribute)
cores_per_node (libensemble.resources.platforms.Platform attribute)
count_gens() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
count_persis_gens() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
create_machinefile() (in module mpi_resources)
crusher (libensemble.resources.platforms.Known_platforms attribute)
D
decide_where_to_start_localopt() (in module persistent_aposmm)
dedicated_mode (libensemble.specs.LibeSpecs attribute)
destroy() (aposmm_localopt_support.LocalOptInterfacer method)
disable_log_files (libensemble.specs.LibeSpecs attribute)
disable_resource_manager (libensemble.specs.LibeSpecs attribute)
doihave_gpus() (resources.worker_resources.WorkerResources method)
done() (libensemble.executors.executor.Task method)
dry_run (libensemble.specs.LibeSpecs attribute)
E
enforce_worker_core_bounds (libensemble.specs.LibeSpecs attribute)
Ensemble (class in libensemble.ensemble)
ensemble_copy_back (libensemble.specs.LibeSpecs attribute)
ensemble_dir_path (libensemble.specs.LibeSpecs attribute)
env_resources
module
EnvResources (class in env_resources)
eprint() (in module tools)
even_assignment() (rset_resources.RSetResources static method)
exception() (libensemble.executors.executor.Task method)
executor
module
Executor (class in libensemble.executors.executor)
executor_hworld
module
executor_hworld() (in module executor_hworld)
expand_list() (rset_resources.RSetResources static method)
F
fast_alloc
module
fd_param_finder() (in module persistent_fd_param_finder)
file_exists_in_workdir() (libensemble.executors.executor.Task method)
final_gen_send (libensemble.specs.LibeSpecs attribute)
ForkablePdb (class in tools)
free_rsets() (resources.worker_resources.ResourceManager method)
from_json() (libensemble.ensemble.Ensemble method)
from_toml() (libensemble.ensemble.Ensemble method)
from_yaml() (libensemble.ensemble.Ensemble method)
frontier (libensemble.resources.platforms.Known_platforms attribute)
func_wrapper() (in module noisy_vector_mapping)
(in module periodic_func)
G
gen_borehole_input() (in module borehole)
gen_dir_copy_files (libensemble.specs.LibeSpecs attribute)
gen_dir_symlink_files (libensemble.specs.LibeSpecs attribute)
gen_dirs_make (libensemble.specs.LibeSpecs attribute)
gen_f (libensemble.specs.GenSpecs attribute)
gen_input_dir (libensemble.specs.LibeSpecs attribute)
gen_max (libensemble.specs.ExitCriteria attribute)
gen_num_gpus (libensemble.specs.LibeSpecs attribute)
gen_num_procs (libensemble.specs.LibeSpecs attribute)
gen_work() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
generic_rocm (libensemble.resources.platforms.Known_platforms attribute)
get_2D_duplicate_indices() (in module persistent_tasmanian)
get_2D_insert_indices() (in module persistent_tasmanian)
get_cobalt_nodelist() (env_resources.EnvResources static method)
get_cpu_cores() (in module node_resources)
get_global_nodelist() (resources.resources.GlobalResources static method)
get_group_list() (rset_resources.RSetResources static method)
get_H0() (in module persistent_tasmanian)
get_hostlist() (in module mpi_resources)
get_index_list() (resources.worker_resources.ResourceManager static method)
get_level() (in module logger)
get_local_nodelist() (resources.worker_resources.WorkerResources static method)
get_lsf_nodelist() (env_resources.EnvResources static method)
get_lsf_nodelist_frm_shortform() (env_resources.EnvResources static method)
get_MPI_runner() (in module mpi_resources)
get_MPI_variant() (in module mpi_resources)
get_nodelist() (env_resources.EnvResources method)
get_partitioned_nodelist() (rset_resources.RSetResources static method)
get_pbs_nodelist() (env_resources.EnvResources static method)
get_resources() (in module mpi_resources)
get_rsets_on_a_node() (rset_resources.RSetResources static method)
get_slots_as_string() (resources.worker_resources.WorkerResources method)
get_slurm_nodelist() (env_resources.EnvResources static method)
get_sparse_grid_specs() (in module persistent_tasmanian)
get_split_list() (rset_resources.RSetResources static method)
get_state() (in module persistent_tasmanian)
get_stderr_level() (in module logger)
get_sub_node_resources() (in module node_resources)
get_workers2assign2() (rset_resources.RSetResources static method)
give_sim_work_first
module
give_sim_work_first() (in module fast_alloc)
(in module give_sim_work_first)
GlobalResources (class in resources.resources)
globus_compute_endpoint (libensemble.specs.GenSpecs attribute)
(libensemble.specs.SimSpecs attribute)
gpu_env_fallback (libensemble.resources.platforms.Platform attribute)
gpu_setting_name (libensemble.resources.platforms.Platform attribute)
gpu_setting_type (libensemble.resources.platforms.Platform attribute)
gpus_per_node (libensemble.resources.platforms.Platform attribute)
grow_H() (libensemble.history.History method)
H
History (class in libensemble.history)
I
init_resources() (resources.resources.Resources class method)
initialize_APOSMM() (in module persistent_aposmm)
inputs (libensemble.specs.GenSpecs attribute)
(libensemble.specs.SimSpecs attribute)
ip (libensemble.specs.LibeSpecs attribute)
is_nodelist_shortnames() (resources.resources.GlobalResources static method)
iterate() (aposmm_localopt_support.LocalOptInterfacer method)
K
kill() (libensemble.executors.balsam_executor.BalsamTask method)
(libensemble.executors.executor.Task method)
kill_canceled_sims (libensemble.specs.LibeSpecs attribute)
L
latin_hypercube_sample() (in module sampling)
lex_le() (in module persistent_tasmanian)
libE() (in module libensemble.libE)
libensemble.alloc_funcs.start_persistent_local_opt_gens
module
libensemble.executors.balsam_executor
module
libensemble.history
module
libensemble.libE
module
LocalOptInterfacer (class in aposmm_localopt_support)
logger
module
logical_cores_per_node (libensemble.resources.platforms.Platform attribute)
M
manager
module
Manager (class in manager)
manager_kill_received() (libensemble.executors.executor.Executor method)
(libensemble.executors.mpi_executor.MPIExecutor method)
manager_main() (in module manager)
manager_poll() (libensemble.executors.executor.Executor method)
(libensemble.executors.mpi_executor.MPIExecutor method)
module
alloc_support
aposmm_localopt_support
borehole
chwirut1
env_resources
executor
executor_hworld
fast_alloc
give_sim_work_first
libensemble.alloc_funcs.start_persistent_local_opt_gens
libensemble.executors.balsam_executor
libensemble.history
libensemble.libE
logger
manager
mpi_executor
mpi_resources
node_resources
noisy_vector_mapping
periodic_func
persistent_aposmm
persistent_fd_param_finder
persistent_sampling
persistent_sampling_var_resources
persistent_support
persistent_surmise_calib
persistent_tasmanian
resources.resources
resources.scheduler
resources.worker_resources
rset_resources
sampling
six_hump_camel
start_only_persistent
tools
uniform_or_localopt
worker
mpi_comm (libensemble.specs.LibeSpecs attribute)
mpi_executor
module
mpi_resources
module
mpi_runner (libensemble.resources.platforms.Platform attribute)
MPIExecutor (class in libensemble.executors.mpi_executor)
MPIResourcesException
N
node_resources
module
noisy_function() (in module noisy_vector_mapping)
noisy_vector_mapping
module
num_resource_sets (libensemble.specs.LibeSpecs attribute)
nworkers (libensemble.specs.LibeSpecs attribute)
O
only_persistent_gens() (in module start_only_persistent)
only_persistent_workers() (in module start_only_persistent)
outputs (libensemble.specs.AllocSpecs attribute)
(libensemble.specs.GenSpecs attribute)
(libensemble.specs.SimSpecs attribute)
P
parse_args() (in module tools)
periodic_func
module
periodic_func() (in module periodic_func)
perlmutter_c (libensemble.resources.platforms.Known_platforms attribute)
perlmutter_g (libensemble.resources.platforms.Known_platforms attribute)
persis_in (libensemble.specs.GenSpecs attribute)
(libensemble.specs.SimSpecs attribute)
persistent_aposmm
module
persistent_fd_param_finder
module
persistent_request_shutdown() (in module persistent_sampling)
persistent_sampling
module
persistent_sampling_var_resources
module
persistent_six_hump_camel() (in module six_hump_camel)
persistent_support
module
persistent_surmise_calib
module
persistent_tasmanian
module
persistent_uniform() (in module persistent_sampling)
persistent_uniform_final_update() (in module persistent_sampling)
persistent_uniform_with_cancellations() (in module persistent_sampling)
PersistentSupport (class in persistent_support)
platform (libensemble.specs.LibeSpecs attribute)
platform_specs (libensemble.specs.LibeSpecs attribute)
points_by_priority() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
polaris (libensemble.resources.platforms.Known_platforms attribute)
poll() (libensemble.executors.balsam_executor.BalsamTask method)
(libensemble.executors.executor.Task method)
polling_loop() (libensemble.executors.executor.Executor method)
(libensemble.executors.mpi_executor.MPIExecutor method)
port (libensemble.specs.LibeSpecs attribute)
profile (libensemble.specs.LibeSpecs attribute)
R
read_file_in_workdir() (libensemble.executors.executor.Task method)
read_stderr() (libensemble.executors.executor.Task method)
read_stdout() (libensemble.executors.executor.Task method)
ready() (libensemble.ensemble.Ensemble method)
recv() (in module libensemble.tools.persistent_support.PersistentSupport)
(persistent_support.PersistentSupport method)
register_app() (libensemble.executors.balsam_executor.BalsamExecutor method)
(libensemble.executors.executor.Executor method)
(libensemble.executors.mpi_executor.MPIExecutor method)
remove_nodes() (resources.resources.GlobalResources static method)
request_cancel_sim_ids() (in module libensemble.tools.persistent_support.PersistentSupport)
(persistent_support.PersistentSupport method)
resource_info (libensemble.specs.LibeSpecs attribute)
ResourceManager (class in resources.worker_resources)
Resources (class in resources.resources)
resources.resources
module
resources.scheduler
module
resources.worker_resources
module
ResourceScheduler (class in resources.scheduler)
result() (libensemble.executors.executor.Task method)
reuse_output_dir (libensemble.specs.LibeSpecs attribute)
revoke_allocation() (libensemble.executors.balsam_executor.BalsamExecutor method)
rset_resources
module
RSetResources (class in rset_resources)
run() (libensemble.ensemble.Ensemble method)
(manager.Manager method)
(worker.Worker method)
run_external_localopt() (in module aposmm_localopt_support)
run_local_dfols() (in module aposmm_localopt_support)
run_local_nlopt() (in module aposmm_localopt_support)
run_local_scipy_opt() (in module aposmm_localopt_support)
run_local_tao() (in module aposmm_localopt_support)
runner_name (libensemble.resources.platforms.Platform attribute)
running() (libensemble.executors.executor.Task method)
S
safe_mode (libensemble.specs.LibeSpecs attribute)
sampling
module
save_every_k_gens (libensemble.specs.LibeSpecs attribute)
save_every_k_sims (libensemble.specs.LibeSpecs attribute)
save_H_and_persis_on_abort (libensemble.specs.LibeSpecs attribute)
save_libE_output() (in module tools)
save_output() (libensemble.ensemble.Ensemble method)
scheduler_match_slots (libensemble.resources.platforms.Platform attribute)
scheduler_opts (libensemble.specs.LibeSpecs attribute)
send() (in module libensemble.tools.persistent_support.PersistentSupport)
(persistent_support.PersistentSupport method)
send_recv() (in module libensemble.tools.persistent_support.PersistentSupport)
(persistent_support.PersistentSupport method)
set_directory() (in module logger)
set_env_to_gpus() (resources.worker_resources.WorkerResources method)
set_env_to_slots() (resources.worker_resources.WorkerResources method)
set_filename() (in module logger)
set_gen_procs_gpus() (resources.worker_resources.WorkerResources method)
set_level() (in module logger)
set_resource_manager() (resources.resources.Resources method)
set_rset_team() (resources.worker_resources.WorkerResources method)
set_slot_count() (resources.worker_resources.WorkerResources method)
set_stderr_level() (in module logger)
set_worker_resources() (resources.resources.Resources method)
shortnames() (env_resources.EnvResources method)
sim_dir_copy_files (libensemble.specs.LibeSpecs attribute)
sim_dir_symlink_files (libensemble.specs.LibeSpecs attribute)
sim_dirs_make (libensemble.specs.LibeSpecs attribute)
sim_f (libensemble.specs.SimSpecs attribute)
sim_input_dir (libensemble.specs.LibeSpecs attribute)
sim_max (libensemble.specs.ExitCriteria attribute)
sim_work() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
six_hump_camel
module
six_hump_camel() (in module six_hump_camel)
six_hump_camel_simple() (in module six_hump_camel)
sparse_grid_async() (in module persistent_tasmanian)
sparse_grid_batched() (in module persistent_tasmanian)
spock (libensemble.resources.platforms.Known_platforms attribute)
start_only_persistent
module
start_persistent_local_opt_gens() (in module libensemble.alloc_funcs.start_persistent_local_opt_gens)
stats_fmt (libensemble.specs.LibeSpecs attribute)
stderr_exists() (libensemble.executors.executor.Task method)
stdout_exists() (libensemble.executors.executor.Task method)
stop_val (libensemble.specs.ExitCriteria attribute)
submit() (libensemble.executors.balsam_executor.BalsamExecutor method)
(libensemble.executors.executor.Executor method)
(libensemble.executors.mpi_executor.MPIExecutor method)
submit_allocation() (libensemble.executors.balsam_executor.BalsamExecutor method)
summit (libensemble.resources.platforms.Known_platforms attribute)
sunspot (libensemble.resources.platforms.Known_platforms attribute)
surmise_calib() (in module persistent_surmise_calib)
T
Task (class in libensemble.executors.executor)
task_partition() (in module mpi_resources)
term_test() (manager.Manager method)
term_test_gen_max() (manager.Manager method)
term_test_sim_max() (manager.Manager method)
term_test_stop_val() (manager.Manager method)
term_test_wallclock() (manager.Manager method)
test_any_gen() (alloc_support.AllocSupport method)
(libensemble.tools.alloc_support.AllocSupport method)
tools
module
trim_H() (libensemble.history.History method)
U
uniform_nonblocking() (in module persistent_sampling)
uniform_or_localopt
module
uniform_or_localopt() (in module uniform_or_localopt)
uniform_random_sample() (in module sampling)
uniform_random_sample_cancel() (in module sampling)
uniform_random_sample_obj_components() (in module sampling)
uniform_random_sample_with_var_priorities_and_resources() (in module sampling)
uniform_random_sample_with_variable_resources() (in module sampling)
uniform_sample() (in module persistent_sampling_var_resources)
uniform_sample_diff_simulations() (in module persistent_sampling_var_resources)
uniform_sample_with_procs_gpus() (in module persistent_sampling_var_resources)
uniform_sample_with_sim_gen_resources() (in module persistent_sampling_var_resources)
uniform_sample_with_var_priorities() (in module persistent_sampling_var_resources)
update_history_dist() (in module persistent_aposmm)
update_history_f() (libensemble.history.History method)
update_history_to_gen() (libensemble.history.History method)
update_history_x_in() (libensemble.history.History method)
update_history_x_out() (libensemble.history.History method)
update_scheduler_opts() (resources.resources.GlobalResources method)
use_persis_return_gen (libensemble.specs.LibeSpecs attribute)
use_persis_return_sim (libensemble.specs.LibeSpecs attribute)
use_worker_dirs (libensemble.specs.LibeSpecs attribute)
use_workflow_dir (libensemble.specs.LibeSpecs attribute)
user (libensemble.specs.AllocSpecs attribute)
(libensemble.specs.GenSpecs attribute)
(libensemble.specs.SimSpecs attribute)
W
wait() (libensemble.executors.balsam_executor.BalsamTask method)
(libensemble.executors.executor.Task method)
wallclock_max (libensemble.specs.ExitCriteria attribute)
workdir_exists() (libensemble.executors.executor.Task method)
worker
module
Worker (class in worker)
worker_cmd (libensemble.specs.LibeSpecs attribute)
worker_main() (in module worker)
worker_timeout (libensemble.specs.LibeSpecs attribute)
workerID (libensemble.specs.LibeSpecs attribute)
WorkerResources (class in resources.worker_resources)
workers (libensemble.specs.LibeSpecs attribute)
workflow_dir_path (libensemble.specs.LibeSpecs attribute)
Z
zero_resource_workers (libensemble.specs.LibeSpecs attribute)
Read the Docs
v: main
Versions
latest
release-v_0.10.0
main
install-setup_changes
hotfix-pin_pydantic
docs-simplify_executor_tutorial
docs-prev1_propose_refactor
develop
Downloads
pdf
On Read the Docs
Project Home
Builds