Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Executable constructor doc #4983

Merged
merged 4 commits into from
Dec 19, 2024
Merged

Improve Executable constructor doc #4983

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e54da0b
Trying to improve Executable constructor doc
pannarale Dec 12, 2024
eb990dc
Attempte to improve documentation for 2 boolean variables
pannarale Dec 13, 2024
3f9a856
Typo
pannarale Dec 13, 2024
603eb14
Merge branch 'gwastro:master' into Executable_doc
pannarale Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pycbc/workflow/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)?
titodalcanton marked this conversation as resolved.
Show resolved Hide resolved
set_submit_subdir: boolean [default True]
titodalcanton marked this conversation as resolved.
Show resolved Hide resolved
Set up the sub-directory to use in the submit directory?
Regulates pegasus --> relative.submit.dir
"""
if isinstance(ifos, str):
self.ifo_list = [ifos]
Expand Down
Loading