cogwheel.utils.submit_condor

cogwheel.utils.submit_condor(submit_path, executable, overwrite=False, args='', multithreading=False, **submit_kwargs)

Generic function to submit a job using HTCondor.

This function is intended to be called from other modules rather than used interactively. The job will run the calling module as script.

Parameters:

submit_pathstr, os.PathLike

File name where to save the submission script.

executablestr, os.PathLike

File name where to save the executable script.

overwritebool

Whether to raise an error if submit_path or executable exist. If True, existing files will be silently overwritten. Default is False.

argsstr

Command line arguments for the calling module’s main() to parse.

multithreadingbool

Whether to enable automatic OMP multithreading. Defaults to False because multithreading is found to be slower despite using more resources.

**submit_kwargs

Specify information in the submit file other than the executable and queue lines. E.g. request_memory='1G'.