python.dags.layers.Layer Class Reference

Public Member Functions
	__post_init__ (self)
	config (self)
	append (self, node)
	extend (self, nodes)
	__iadd__ (self, nodes)
	validate (self)
	has_dependencies (self)

Static Public Attributes
Optional	name = ""
Optional	universe = "vanilla"
Optional	log_dir = "logs"
Optional	retries = 3
Optional	transfer_files = True
Optional	dynamic_memory = False
Optional	requirements = field(default_factory=dict)
Optional	inputs = field(default_factory=dict)
Optional	outputs = field(default_factory=dict)
Optional	nodes = field(default_factory=list)

Protected Member Functions
	_arguments (self)
	_inputs (self)
	_outputs (self)
	_output_remaps (self)
	_vars (self)

Detailed Description

Defines a single layer (or set of related jobs) in an HTCondor DAG.

    Stores submit configuration for a set of nodes as well as
    providing functionality to determine the parent-child
    relationships between nodes.

    Parameters
    ----------
    executable
        The path of the executable to run.
    name
        The human-readable name of this node. Defaults to the basename
        of the executable if not given.
    universe
        The execution environment for a job. Defaults to 'vanilla'.
    retries
        The number of retries given for a job. Defaults to 3.
    transfer_files
        Whether to leverage Condor file transfer for moving around
        files. On by default.
    dynamic_memory
        Whether to dynamically increase memory request if jobs are
        put on hold due to going over memory requested.
        Off by default.
    requirements
        Additional key-value pairs in the submit description.
    inputs
        The arguments the nodes takes as inputs. If not specified,
        they will be automatically generated when nodes are added
        to this layer.
    outputs
        The arguments the nodes takes as outputs. If not specified,
        they will be automatically generated when nodes are added
        to this layer.
    nodes
        The nodes representing the layer. Nodes can be passed upon
        instantiation or added to the layer after the fact via
        Layer.append(node), Layer.extend(nodes), or Layer += node.

Definition at line 31 of file __init__.py.

Member Function Documentation

__iadd__()

python.dags.layers.Layer.__iadd__	(		self,
			nodes )

Definition at line 156 of file __init__.py.

__post_init__()

python.dags.layers.Layer.__post_init__

(

self

)

Definition at line 84 of file __init__.py.

_arguments()

python.dags.layers.Layer._arguments ( self )

protected

Definition at line 183 of file __init__.py.

_inputs()

python.dags.layers.Layer._inputs ( self )

protected

Definition at line 195 of file __init__.py.

_output_remaps()

python.dags.layers.Layer._output_remaps ( self )

protected

Definition at line 201 of file __init__.py.

_outputs()

python.dags.layers.Layer._outputs ( self )

protected

Definition at line 198 of file __init__.py.

_vars()

python.dags.layers.Layer._vars ( self )

protected

Definition at line 204 of file __init__.py.

append()

python.dags.layers.Layer.append	(		self,
			node )

Definition at line 145 of file __init__.py.

config()

python.dags.layers.Layer.config

(

self

)

Definition at line 88 of file __init__.py.

extend()

python.dags.layers.Layer.extend	(		self,
			nodes )

Definition at line 152 of file __init__.py.

has_dependencies()

python.dags.layers.Layer.has_dependencies

(

self

)

Definition at line 180 of file __init__.py.

validate()

python.dags.layers.Layer.validate

(

self

)

Definition at line 163 of file __init__.py.

Member Data Documentation

dynamic_memory

Optional python.dags.layers.Layer.dynamic_memory = False

static

Definition at line 78 of file __init__.py.

inputs

Optional python.dags.layers.Layer.inputs = field(default_factory=dict)

static

Definition at line 80 of file __init__.py.

log_dir

Optional python.dags.layers.Layer.log_dir = "logs"

static

Definition at line 75 of file __init__.py.

name

python.dags.layers.Layer.name = ""

static

Definition at line 73 of file __init__.py.

nodes

python.dags.layers.Layer.nodes = field(default_factory=list)

static

Definition at line 82 of file __init__.py.

outputs

Optional python.dags.layers.Layer.outputs = field(default_factory=dict)

static

Definition at line 81 of file __init__.py.

requirements

python.dags.layers.Layer.requirements = field(default_factory=dict)

static

Definition at line 79 of file __init__.py.

retries

python.dags.layers.Layer.retries = 3

static

Definition at line 76 of file __init__.py.

transfer_files

Optional python.dags.layers.Layer.transfer_files = True

static

Definition at line 77 of file __init__.py.

universe

Optional python.dags.layers.Layer.universe = "vanilla"

static

Definition at line 74 of file __init__.py.

---

The documentation for this class was generated from the following file:

• /home/abuild/rpmbuild/BUILD/gstlal-1.13.0-build/build_python313/python/dags/layers/__init__.py