lsst.ctrl.bps.htcondor

Changes

• lsst-ctrl-bps-htcondor v29.1.0 (2025-06-13)
• lsst-ctrl-bps-htcondor v29.0.0 (2025-03-25)
• lsst-ctrl-bps-htcondor v28.0.0 (2024-11-21)
• lsst-ctrl-bps-htcondor v27.0.0 (2024-06-04)
• lsst-ctrl-bps-htcondor v26.0.0 (2023-09-25)
• lsst-ctrl-bps-htcondor v25.0.0 (2023-03-02)
• lsst-ctrl-bps-htcondor v24.0.0 (2022-08-29)
• ctrl_bps v23.0.0 (2021-12-10)

Using lsst.ctrl.bps.htcondor

• Overview
• Prerequisites
• Installing the plugin
• Specifying the plugin
• Defining a submission
• Submitting a run
• Checking status
• Printing a report
• Canceling submitted jobs
• Restarting a failed run
• Provisioning resources automatically
• Releasing held jobs
• Troubleshooting

Contributing

lsst.ctrl.bps.htcondor is developed at https://github.com/lsst/ctrl_bps_htcondor. You can find Jira issues for this module under the ctrl_bps_htcondor component.

Python API reference

lsst.ctrl.bps.htcondor Package

Functions

condor_history([constraint, schedds])	Get information about the jobs from HTCondor history records.
condor_q([constraint, schedds])	Get information about the jobs in the HTCondor job queue(s).
condor_search([constraint, hist, schedds])	Search for running and finished jobs satisfying given criteria.
condor_status([constraint, coll])	Get information about HTCondor pool.
htc_backup_files(wms_path[, subdir, limit])	Backup select HTCondor files in the submit directory.
htc_check_dagman_output(wms_path)	Check the DAGMan output for error messages.
htc_create_submit_from_cmd(dag_filename[, ...])	Create a DAGMan job submit description.
htc_create_submit_from_dag(dag_filename, ...)	Create a DAGMan job submit description.
htc_create_submit_from_file(submit_file)	Parse a submission file.
htc_escape(value)	Escape characters in given value based upon HTCondor syntax.
htc_query_history(schedds, **kwargs)	Fetch history records from the condor_schedd daemon.
htc_query_present(schedds, **kwargs)	Query the condor_schedd daemon for job ads.
htc_submit_dag(sub)	Submit job for execution.
htc_version()	Return the version given by the HTCondor API.
htc_write_attribs(stream, attrs)	Write job attributes in HTCondor format to writeable stream.
htc_write_condor_file(filename, job_name, ...)	Write an HTCondor submit file.
pegasus_name_to_label(name)	Convert pegasus job name to a label for the report.
read_dag_info(wms_path)	Read custom DAGMan job information from the file.
read_dag_log(wms_path)	Read job information from the DAGMan log file.
read_dag_nodes_log(wms_path)	Read job information from the DAGMan nodes log file.
read_dag_status(wms_path)	Read the node status file for DAG summary information.
read_node_status(wms_path)	Read entire node status file.
summarize_dag(dir_name)	Build bps_run_summary string from dag file.
update_job_info(job_info, other_info)	Update results of a job query with results from another query.
write_dag_info(filename, dag_info)	Write custom job information about DAGMan job.

Classes

DagStatus(value[, names, module, qualname, ...])	HTCondor DAGMan's statuses for a DAG.
HTCDag([data, name])	HTCondor DAG.
HTCJob(name[, label, initcmds, initdagcmds, ...])	HTCondor job for use in building DAG.
HTCondorService(config)	HTCondor version of WMS service.
HTCondorWorkflow(name[, config])	Single HTCondor workflow.
NodeStatus(value[, names, module, qualname, ...])	HTCondor's statuses for DAGman nodes.
RestrictedDict(valid_keys[, init_data])	A dictionary that only allows certain keys.
WmsNodeType(value[, names, module, ...])	HTCondor plugin node types to help with payload reporting.