b2luigi.basf2_helper package#

b2luigi.basf2_helper.data module#

class b2luigi.basf2_helper.data.CdstDataTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.data.DstDataTask

data_mode = 'cdst'#
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

class b2luigi.basf2_helper.data.DataMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: enum.Enum

cdst = 'cdst'#
mdst = 'mdst'#
raw = 'raw'#
skimmed_raw = 'skimmed_raw'#
class b2luigi.basf2_helper.data.DataTask(*args, **kwargs)#

Bases: b2luigi.core.task.ExternalTask

data_mode = <luigi.parameter.EnumParameter object>#
experiment_number = <luigi.parameter.IntParameter object>#
file_name = <luigi.parameter.Parameter object>#
prefix = <luigi.parameter.Parameter object>#
run_number = <luigi.parameter.IntParameter object>#
class b2luigi.basf2_helper.data.DstDataTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.data.DataTask

database = <luigi.parameter.IntParameter object>#
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

prod = <luigi.parameter.IntParameter object>#
release = <luigi.parameter.Parameter object>#
class b2luigi.basf2_helper.data.MdstDataTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.data.DstDataTask

data_mode = 'mdst'#
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

class b2luigi.basf2_helper.data.RawDataTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.data.DataTask

data_mode = 'raw'#
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

class b2luigi.basf2_helper.data.SkimmedRawDataTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.data.DstDataTask

data_mode = 'skimmed_raw'#
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

b2luigi.basf2_helper.data.clone_on_cdst(self, task_class, experiment_number, run_number, release, prod, database, prefix=None, file_name=None, **additional_kwargs)#
b2luigi.basf2_helper.data.clone_on_mdst(self, task_class, experiment_number, run_number, release, prod, database, prefix=None, file_name=None, **additional_kwargs)#
b2luigi.basf2_helper.data.clone_on_raw(self, task_class, experiment_number, run_number, prefix=None, file_name=None, **additional_kwargs)#
b2luigi.basf2_helper.data.clone_on_skimmed_raw(self, task_class, experiment_number, run_number, release, prod, database, prefix=None, file_name=None, **additional_kwargs)#

b2luigi.basf2_helper.targets module#

class b2luigi.basf2_helper.targets.ROOTLocalTarget(path=None, format=None, is_tmp=False)#

Bases: luigi.local_target.LocalTarget

exists()#

Returns True if the path for this FileSystemTarget exists; False otherwise.

This method is implemented by using fs.

b2luigi.basf2_helper.tasks module#

class b2luigi.basf2_helper.tasks.Basf2FileMergeTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.MergerTask

cmd = ['b2file-merge', '-f']#
class b2luigi.basf2_helper.tasks.Basf2PathTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.Basf2Task

create_path()#
max_event = <luigi.parameter.IntParameter object>#
num_processes = <luigi.parameter.IntParameter object>#
process()#

Override this method with your normal run function. Do not touch the run function itself!

class b2luigi.basf2_helper.tasks.Basf2Task(*args, **kwargs)#

Bases: b2luigi.core.dispatchable_task.DispatchableTask

get_output_file_target(*args, **kwargs)#
get_serialized_parameters()#
git_hash = <luigi.parameter.Parameter object>#
class b2luigi.basf2_helper.tasks.Basf2nTupleMergeTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.MergerTask

property cmd#

Command to use to merge basf2 tuple files.

class b2luigi.basf2_helper.tasks.HaddTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.MergerTask

cmd = ['hadd', '-f']#
class b2luigi.basf2_helper.tasks.MergerTask(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.Basf2Task

cmd = []#
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

process()#

Override this method with your normal run function. Do not touch the run function itself!

class b2luigi.basf2_helper.tasks.SimplifiedOutputBasf2Task(*args, **kwargs)#

Bases: b2luigi.basf2_helper.tasks.Basf2PathTask

create_path()#
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

b2luigi.basf2_helper.utils module#

b2luigi.basf2_helper.utils.get_basf2_git_hash()#

Return name of basf2 release or if local basf2 is used its version hash.

The version is equivalent to the version returned by basf2 --version.

Returns "not set", if no basf2 release is set and basf2 cannot be imported.