options

Argument dataclass

Defines a command-line argument (positional).

This provides some extra functionality over defining command line argument explicitly, in addition to some extra parameters which sets how condor interprets how to handle them within the DAG and within submit descriptions.

Parameters:

Name	Type	Description	Default
name	str	The option name. Since this is a positional argument, it is not used explicitly in the command, but is needed to define variable names within jobs.	required
argument	Union[int, float, str, List]	The positional argument value(s) used in a command.	required
track	bool	Whether to track files defined here and used externally within jobs to determine parent-child relationships when nodes specify this option as an input or output. On by default.	True
suppress	bool	Whether to hide this option. Used externally within jobs to determine whether to define job arguments. This is typically used when you want to track file I/O used by a job but isn't directly specified in their commands. Off by default.	False

Examples:

>>> Argument("command", "run").vars()
'run'

>>> files = ["input_1.txt", "input_2.txt"]
>>> Argument("input-files", files).vars()
'input_1.txt input_2.txt'

Literal dataclass

Defines a command-line literal.

This provides some extra functionality over defining command line argument explicitly, in addition to some extra parameters which sets how condor interprets how to handle them within the DAG and within submit descriptions.

Parameters:

Name	Type	Description	Default
argument	Union[int, float, str]	The positional argument value(s) used in a command.	required
track	bool	Whether to track files defined here and used externally within jobs to determine parent-child relationships when nodes specify this option as an input or output. On by default.	True

Examples:

>>> Literal("run").vars()
'run'

>>> Literal("/path/to/input_1.txt").remaps()
'input_1.txt=/path/to/input_1.txt'

Option dataclass

Defines a command-line option (long form).

This provides some extra functionality over defining command line options explicitly, in addition to some extra parameters which sets how condor interprets how to handle them within the DAG and within submit descriptions.

Parameters:

Name	Type	Description	Default
name	str	The option name to be used in a command.	required
argument	Optional[Union[int, float, str, List]]	The argument value(s) used in a command.	None
track	Optional[bool]	Whether to track files defined here and used externally within jobs to determine parent-child relationships when nodes specify this option as an input or output. On by default.	True
suppress	Optional[bool]	Whether to hide this option. Used externally within jobs to determine whether to define job arguments. This is typically used when you want to track file I/O used by a job but isn't directly specified in their commands. Off by default.	False
prefix	Optional[str]	The option prefix to use, e.g. for --verbose, -- is the prefix. Uses -- by default.	'--'

Examples:

>>> Option("verbose").vars()
'--verbose'

>>> Option("input-type", "file").vars()
'--input-type file'

>>> Option("ifos", ["H1", "L1", "V1"]).vars()
'--ifos H1 --ifos L1 --ifos V1'