From e54da0b476fc13d41f8c2fcd3c6872007afd0c05 Mon Sep 17 00:00:00 2001 From: Francesco Pannarale Date: Thu, 12 Dec 2024 08:46:43 -0800 Subject: [PATCH 1/3] Trying to improve Executable constructor doc --- pycbc/workflow/core.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/pycbc/workflow/core.py b/pycbc/workflow/core.py index 8bde5c7cc00..0900015d921 100644 --- a/pycbc/workflow/core.py +++ b/pycbc/workflow/core.py @@ -121,10 +121,8 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None, ----------- cp : ConfigParser object The ConfigParser object holding the workflow configuration settings - exec_name : string + name : string Executable name - universe : string, optional - Condor universe to run the job in ifos : string or list, optional The ifo(s) that the Job is valid for. If the job is independently valid for multiple ifos it can be provided as a list. @@ -135,6 +133,11 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None, The folder to store output files of this job. tags : list of strings A list of strings that is used to identify this job. + reuse_executable: boolean [default True] + Set pegasus_name to name (rather than tagged_name)? + set_submit_subdir: boolean [default True] + Set up the sub-directory to use in the submit directory? + Regulates pegasus --> relative.submit.dir """ if isinstance(ifos, str): self.ifo_list = [ifos] From eb990dc533d649eb55088b0e1ce107fa93647e32 Mon Sep 17 00:00:00 2001 From: Francesco Pannarale Date: Thu, 12 Dec 2024 22:58:17 -0800 Subject: [PATCH 2/3] Attempte to improve documentation for 2 boolean variables --- pycbc/workflow/core.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/pycbc/workflow/core.py b/pycbc/workflow/core.py index 0900015d921..d081c8909b0 100644 --- a/pycbc/workflow/core.py +++ b/pycbc/workflow/core.py @@ -134,10 +134,15 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None, tags : list of strings A list of strings that is used to identify this job. reuse_executable: boolean [default True] - Set pegasus_name to name (rather than tagged_name)? + If True, Pegasus simply uses the name of the (executable) script + to label the Executable instance, otherwise it also includes tags + in the labeling and, e.g., performance information is recorded + individually by jov rather than being grouped together on the + basis of the script name. set_submit_subdir: boolean [default True] - Set up the sub-directory to use in the submit directory? - Regulates pegasus --> relative.submit.dir + Place condor files associated with this executable under a + sub-directory (named according to the executable name) in the + submitdir. """ if isinstance(ifos, str): self.ifo_list = [ifos] From 3f9a8568e6e00b60811eaaf9c29c9bf0adc35b32 Mon Sep 17 00:00:00 2001 From: Francesco Pannarale Date: Thu, 12 Dec 2024 22:59:52 -0800 Subject: [PATCH 3/3] Typo --- pycbc/workflow/core.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pycbc/workflow/core.py b/pycbc/workflow/core.py index d081c8909b0..b3c4c8624f0 100644 --- a/pycbc/workflow/core.py +++ b/pycbc/workflow/core.py @@ -137,7 +137,7 @@ def __init__(self, cp, name, ifos=None, out_dir=None, tags=None, If True, Pegasus simply uses the name of the (executable) script to label the Executable instance, otherwise it also includes tags in the labeling and, e.g., performance information is recorded - individually by jov rather than being grouped together on the + individually by job rather than being grouped together on the basis of the script name. set_submit_subdir: boolean [default True] Place condor files associated with this executable under a