icaruscode/fcl/configurations/rootoutput_icarus.fcl at b79d3b76ebe0b85a2c8220bf48918cd333800ded · SBNSoftware/icaruscode · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#
# File:    rootoutput_icarus.fcl
# Purpose: standard _art_ ROOT output file naming
# Author:  Gianluca Petrillo (petrillo@slac.stanford.edu)
# Date:    December 4, 2019
#
# This file provides a base configuration for the ROOT output module which
# includes a standard name based on the input file.
#
# Provided configuration:
#
# * `icarus_rootoutput`: configuration for `RootOutput` module
# * `icarus_rootoutput_one_output_per_input`: variant of `icarus_rootoutput`
#      producing one output file per input file
# * `icarus_rootoutput_fromempty`: (BROKEN) configuration for `EmptyEvent` module
#
# See below for usage examples.
#

BEGIN_PROLOG

################################################################################
###  RootOutput: icarus_rootoutput
################################################################################
###
### Standard configuration for `RootOutput` module.
### Use it in the configuration of jobs using an input ROOT file (e.g. with
### `RootInput` module, but not with jobs using `EmptyEvent`).
###
### Example of usage:
###
###     outputs: {
###       rootoutput: @local::icarus_rootoutput
###     }
###
### will cause the job to create a _art_ ROOT file named after the input file,
### with the process name and file closing time added.
### The file has minimal standard ROOT compression (level 1).
### Fast cloning is left default.
###
###
icarus_rootoutput: {
  module_type:       RootOutput
  fileName:         "%ifb_%tc-%p.root"
  compressionLevel:  1
  dataTier:         "simulated" # still parroting something I don't understand
  saveMemoryObjectThreshold: 0

  # this will run the SaveJobEnvironment results producer module every time
  # RootOutput is used; see
  # https://cdcvs.fnal.gov/redmine/projects/art/wiki/Release_Notes_11600#-Release-feature-Issue-7449-Analysis-support-requires-ability-to-store-objects-in-file-in-branch-other-than-Run-SubRun-or-Event
  results: {
    producers: {
      writeConfig: {
        plugin_type: SaveJobEnvironment
        Repositories: [ icaruscode, sbndcode ]
      }
    }
    result_path: [ writeConfig ]
  }

} # icarus_rootoutput


###
### Variant: produce one output file for each input file, instead of merging
### all the output in a single file.
###
icarus_rootoutput_one_output_per_input: {
  @table::icarus_rootoutput

  # set one output file per input file
  fileProperties: {
      maxInputFiles: 1
  }

  # when fileProperies are specified, RootOutput enforces the presence of a "%#"
  # in the output file name to ensure no output files end up with the same name;
  # our output file names include the input file name, so we don't face that
  # issue and we can disable that check and get away without "%#".
  checkFileName: false

} # icarus_rootoutput_one_output_per_input


################################################################################
###  RootOutput: icarus_rootoutput_fromempty
################################################################################
###
### Standard configuration for `RootOutput` module for jobs without an input
### ROOT file (e.g. jobs using `EmptyEvent`).
###
### Example of usage:
###
###     outputs: {
###       rootoutput: @local::icarus_rootoutput_fromempty
###     }
###
### will cause the job to create a _art_ ROOT file following the same settings
### as for `rootoutput_icarus`, except that the name of the output file is
### the name of the configuration file, with the process name and file closing
### time added.
###
### WARNING
### WARNING This configuration is not functional, waiting for the necessary
### WARNING feature to be implemented in _art_
### WARNING (request #22357: https://cdcvs.fnal.gov/redmine/issues/22357)
### WARNING
###
icarus_rootoutput_fromempty: {
  @table::icarus_rootoutput
  fileName:                 "%c_%tc-%p.root"
} # icarus_rootoutput_fromempty


################################################################################

END_PROLOG