WorkQueue¶

class lsst.ctrl.bps.parsl.sites.WorkQueue(*args, **kwargs)¶

Bases: SiteConfig

Base class configuraton for WorkQueueExecutor.

Subclasses must provide implementations for .get_executors and .select_executor. In .get_executors, the site-specific ExecutionProvider must be defined.

Parameters:

*argsAny: Parameters forwarded to base class constructor.
**kwargsAny: Keyword arguments passed to base class constructor, augmented by the add_resources argument.

Notes

The following BPS configuration parameters are recognized, overriding the defaults:

port (int): The port used by work_queue. Default: 9000.
worker_options (`str`): Extra options to pass to work_queue workers. A typical option specifies the memory available per worker, e.g., ``"--memory=90000", which sets the available memory to 90 GB. Default: ""
wq_max_retries (int): The number of retries that work_queue will make in case of task failures. Set to None to have work_queue retry forever; set to 1 to have retries managed by Parsl. Default: 1

Methods Summary

`from_config`(config)	Get the site configuration nominated in the BPS config.
`get_address`()	Return the IP address of the machine hosting the driver/submission.
`get_command_prefix`()	Return command(s) to add before each job command.
`get_executors`()	Get a list of executors to be used in processing.
`get_monitor`()	Get parsl monitor.
`get_parsl_config`()	Get Parsl configuration for this site.
`get_site_subconfig`(config)	Get BPS configuration for the site of interest.
`make_executor`(label, provider, *[, port, ...])	Return a `WorkQueueExecutor`.
`select_executor`(job)	Get the `label` of the executor to use to execute a job.

Methods Documentation

classmethod from_config(config: BpsConfig) → SiteConfig¶

Get the site configuration nominated in the BPS config.

The computeSite (str) value in the BPS configuration is used to select a site configuration. The site configuration class to use is specified by the BPS configuration as site.<computeSite>.class (str), which should be the fully-qualified name of a python class that inherits from SiteConfig.

Parameters:

configBpsConfig: BPS configuration.

Returns:

site_configsubclass of SiteConfig: Site configuration.

get_address() → str¶

Return the IP address of the machine hosting the driver/submission.

This address should be accessible from the workers. This should generally by the return value of one of the functions in parsl.addresses.

This is used by the default implementation of get_monitor, but will generally be used by get_executors too.

This default implementation gets the address from the hostname, but that will not work if the workers don’t access the driver/submission node by that address.

get_command_prefix() → str¶

Return command(s) to add before each job command.

These may be used to configure the environment for the job.

This default implementation respects the BPS configuration elements:

site.<computeSite>.commandPrefix (str): command(s) to use as a prefix to executing a job command on a worker.
site.<computeSite>.environment (bool): add bash commands that replicate the environment on the driver/submit machine?

abstract get_executors() → list[parsl.executors.base.ParslExecutor]¶

Get a list of executors to be used in processing.

Each executor should have a unique label.

get_monitor() → MonitoringHub | None¶

Get parsl monitor.

The parsl monitor provides a database that tracks the progress of the workflow and the use of resources on the workers.

This implementation respects the BPS configuration elements:

site.<computeSite>.monitorEnable (bool): enable monitor?
site.<computeSite>.monitorInterval (float): time interval (sec) between logging of resource usage.
site.<computeSite>.monitorFilename (str): name of file to use for the monitor sqlite database.

Returns:

monitorMonitoringHub or None: Parsl monitor, or None for no monitor.

get_parsl_config() → Config¶

Get Parsl configuration for this site.

Subclasses can overwrite this method to build a more specific Parsl configuration, if required.

The retries are set from the site.<computeSite>.retries value found in the BPS configuration file.

Returns:

configparsl.config.Config: The configuration to be used for Parsl.

static get_site_subconfig(config: BpsConfig) → BpsConfig¶

Get BPS configuration for the site of interest.

We return the BPS sub-configuration for the site indicated by the computeSite value, which is site.<computeSite>.

Parameters:

configBpsConfig: BPS configuration.

Returns:

siteBpsConfig: Site sub-configuration.

make_executor(label: str, provider: ExecutionProvider, *, port: int = 9000, worker_options: str = '', wq_max_retries: int = 1) → ParslExecutor¶

Return a WorkQueueExecutor. The provider contains the site-specific configuration.

Parameters:

labelstr: Label for executor.
providerExecutionProvider: Parsl execution provider, e.g., SlurmProvider.
portint, optional: Port used by work_queue. Default: 9000.
worker_optionsstr, optional: Extra options to pass to work_queue workers, e.g., "--memory=90000". Default: "".
wq_max_retriesint, optional: Number of retries for work_queue to attempt per job. Set to None to have it try indefinitely; set to 1 to have Parsl control the number of retries. Default: 1.

abstract select_executor(job: ParslJob) → str¶

Get the label of the executor to use to execute a job.

Parameters:

jobParslJob: Job to be executed.

Returns:

labelstr: Label of executor to use to execute job.

Navigation

WorkQueue¶