yields

Tasks to produce yield tables

Classes:

CreateYieldTable(*args, **kwargs)

class CreateYieldTable(*args, **kwargs)

Bases: DatasetsProcessesMixin, CategoriesMixin, ProducersMixin, SelectorStepsMixin, CalibratorsMixin, LocalWorkflow, RemoteWorkflow

Attributes:

sandbox
table_format
number_format
skip_uncertainties
normalize_yields
output_suffix
reqs
exclude_index
exclude_params_branch
exclude_params_htcondor_workflow
exclude_params_index
exclude_params_remote_workflow
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
exclude_params_slurm_workflow
exclude_params_workflow

Methods:

create_branch_map()	Abstract method that must be overwritten by inheriting tasks to define the branch map.
requires()	The Tasks that this Task depends on.
workflow_requires()	Hook to add workflow requirements.
resolve_param_values(params)	Resolve values params and check against possible default values and producer groups.
output()	The output that this Task produces.
run()	The task run method, to be overridden in a subclass.

sandbox = 'bash::$CF_BASE/sandboxes/venv_columnar.sh'

table_format = <luigi.parameter.Parameter object>

number_format = <luigi.parameter.Parameter object>

skip_uncertainties = <luigi.parameter.BoolParameter object>

normalize_yields = <luigi.parameter.ChoiceParameter object>

output_suffix = <luigi.parameter.Parameter object>

reqs = {'BuildBashSandbox': <class 'columnflow.tasks.framework.remote.BuildBashSandbox'>, 'BundleBashSandbox': <class 'columnflow.tasks.framework.remote.BundleBashSandbox'>, 'BundleCMSSWSandbox': <class 'columnflow.tasks.framework.remote.BundleCMSSWSandbox'>, 'BundleRepo': <class 'columnflow.tasks.framework.remote.BundleRepo'>, 'BundleSoftware': <class 'columnflow.tasks.framework.remote.BundleSoftware'>, 'MergeHistograms': <class 'columnflow.tasks.histograms.MergeHistograms'>}

create_branch_map()

Abstract method that must be overwritten by inheriting tasks to define the branch map.

requires()

The Tasks that this Task depends on.

A Task will only run if all of the Tasks that it requires are completed. If your Task does not require any other Tasks, then you don’t need to override this method. Otherwise, a subclass can override this method to return a single Task, a list of Task instances, or a dict whose values are Task instances.

See Task.requires

workflow_requires()

Hook to add workflow requirements. This method is expected to return a dictionary. When this method is called from a branch task, an exception is raised.

classmethod resolve_param_values(params)

Resolve values params and check against possible default values and producer groups.

Check the values in params against the default value "default_producer" and possible group definitions "producer_groups" in the current config inst. For more information, see resolve_config_default_and_groups().

Parameters:

params – Parameter values to resolve

Returns:

Dictionary of parameters that contains the list requested Producer instances under the keyword "producer_insts". See get_producer_insts() for more information.

output()

The output that this Task produces.

The output of the Task determines if the Task needs to be run–the task is considered finished iff the outputs all exist. Subclasses should override this method to return a single Target or a list of Target instances.

Implementation note

If running multiple workers, the output must be a resource that is accessible by all workers, such as a DFS or database. Otherwise, workers might compute the same output since they don’t see the work done by other workers.

See Task.output

run()

The task run method, to be overridden in a subclass.

See Task.run

exclude_index = False

exclude_params_branch = {'acceptance', 'branches', 'cancel_jobs', 'cleanup_jobs', 'htcondor_cpus', 'htcondor_flavor', 'htcondor_gpus', 'htcondor_logs', 'htcondor_memory', 'htcondor_pool', 'htcondor_scheduler', 'htcondor_share_software', 'ignore_submission', 'job_workers', 'max_runtime', 'no_poll', 'parallel_jobs', 'pilot', 'poll_fails', 'poll_interval', 'retries', 'shuffle_jobs', 'slurm_flavor', 'slurm_partition', 'submission_threads', 'tasks_per_job', 'tolerance', 'transfer_logs', 'walltime'}

exclude_params_htcondor_workflow = {}

exclude_params_index = {'effective_workflow'}

exclude_params_remote_workflow = {}

exclude_params_repr = {'cancel_jobs', 'cleanup_jobs', 'workflow'}

exclude_params_repr_empty = {'selector_steps'}

exclude_params_req = {'effective_workflow'}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

exclude_params_slurm_workflow = {}

exclude_params_workflow = {'branch'}