rsopt.libe_tools package¶
Subpackages¶
- rsopt.libe_tools.generator_functions package
- Submodules
- rsopt.libe_tools.generator_functions.local_opt_generator module
- rsopt.libe_tools.generator_functions.particle_swarm module
- rsopt.libe_tools.generator_functions.persistent_dlib module
- rsopt.libe_tools.generator_functions.persistent_mobo module
- rsopt.libe_tools.generator_functions.persistent_pysot module
- rsopt.libe_tools.generator_functions.rsopt_localopt_support module
- rsopt.libe_tools.generator_functions.sobal module
- rsopt.libe_tools.generator_functions.utility_generators module
- Module contents
- rsopt.libe_tools.simulation_functions package
Submodules¶
rsopt.libe_tools.executors module¶
- class rsopt.libe_tools.executors.SerialExecutor[source]¶
Bases:
Executor- add_comm_info(libE_nodes, serial_setup)[source]¶
Adds comm-specific information to executor. Updates resources information if auto_resources is true.
- submit(calc_type=None, app_name=None, app_args=None, stdout=None, stderr=None, dry_run=False, wait_on_start=False)[source]¶
Create a new task and run as a local serial subprocess.
The created
taskobject is returned.- Parameters:
calc_type (str, Optional) – The calculation type: ‘sim’ or ‘gen’ Only used if app_name is not supplied. Uses default sim or gen application.
app_name (str, Optional) – The application name. Must be supplied if calc_type is not.
app_args (str, Optional) – A str of the application arguments to be added to task submit command line
stdout (str, Optional) – A standard output filename
stderr (str, Optional) – A standard error filename
dry_run (bool, Optional) – Whether this is a dry_run - no task will be launched; instead runline is printed to logger (at INFO level)
wait_on_start (bool, Optional) – Whether to wait for task to be polled as RUNNING (or other active/end state) before continuing
env_script (str, Optional) – The full path of a shell script to set up the environment for the launched task. This will be run in the subprocess, and not affect the worker environment. The script should start with a shebang.
- Returns:
task – The launched task object
- Return type:
Task
- rsopt.libe_tools.executors.register_rsmpi_executor(hosts: str = 'auto') MPIExecutor[source]¶
Create an MPIExecutor that can use rsmpi. The executor is returned and may be used to register calculations for workers like any other libEnsemble executor. :param hosts: (str or list) If ‘auto’ then all rsmpi resources are detected and used. If a list is given
the list entries are written to the libe_nodes file.
- Returns:
libensemble.executors.mpi_executor.MPIExecutor object