Config changes: options.stream -> options.input_stream, Turbo -> TurboPass

DaVinciExamples/example_data/FEST_November_2021_dst_newPacking.yaml

@@ -11,6 +11,6 @@ geometry_version: trunk
 histo_file: v2_example_histos.root
 ntuple_file: v2_example_ntuples.root
 input_process: Hlt2
-stream: default
+input_stream: default
 print_freq: 1000
 input_raw_format: 0.5

DaVinciExamples/example_data/Run255620.yaml

@@ -11,7 +11,7 @@ evt_max : 10000
 ntuple_file: "Raw_DV_Ks_example.root"
 
 input_raw_format: 0.5
-input_process: 'Hlt2'
+input_process: Hlt2
 conditions_version: AlignmentV9_2023_03_16_VPSciFiRich
 geometry_version: trunk
 python_logging_level: 3

DaVinciExamples/example_data/Upgrade_LbToLcmunu.yaml

@@ -12,6 +12,6 @@ input_raw_format: 0.5
 lumi: false
 ntuple_file: 'mytuple.root'
 print_freq: 1
-input_process: 'Hlt2'
-stream: 'default'
+input_process: Hlt2
+input_stream: default
 evt_max: -1

DaVinciExamples/example_data/spruce_b2jpsik_opt.yaml

@@ -11,5 +11,5 @@ conddb_tag: sim-20201218-vc-md100
 dddb_tag: dddb-20201211
 conditions_version: master
 geometry_version: trunk
-input_process: Turbo
+input_process: TurboPass
 

DaVinciExamples/example_data/test_passthrough_thor_lines.yaml

@@ -10,5 +10,5 @@ conditions_version: master
 geometry_version: trunk
 histo_file: passthrough_histos.root
 ntuple_file: passthrough_tuple.root
-input_process: Turbo
+input_process: TurboPass
 print_freq: 1000

DaVinciExamples/example_data/test_tistos.yaml

@@ -12,5 +12,5 @@ ntuple_file: tuple_tistos.root
 evt_max: -1
 write_fsr: False
 print_freq: 1000
-input_process: 'Hlt2'
+input_process: Hlt2
 

DaVinciExamples/example_options/example_tupling_allfunctors.yaml

@@ -12,5 +12,5 @@
     lumi: false
     ntuple_file: 'DV_example_allFunctors_ntp.root'
     print_freq: 1
-    input_process: 'Spruce'
-    stream: 'default'
+    input_process: Spruce
+    input_stream: default
\ No newline at end of file

DaVinciExamples/example_options/example_tupling_from_spruce.yaml

-evt_pre_filters:
-  Hlt2TopoLineFilter: "HLT_PASS('Hlt2Topo2BodyLineDecision')"
+Hlt2TopoLineFilter: "HLT_PASS('Hlt2Topo2BodyLineDecision')"
 ntuple_file: "DV_example_sprucing_ntp.root"
 histo_file: "DV_example_sprucing_his.root"
 print_freq: 1
\ No newline at end of file

DaVinciExamples/example_options/example_tupling_relation_isovariables.yaml

@@ -4,4 +4,4 @@ ntuple_file: davinci_ntuple_ft.root
 print_freq: 1
 data_type: Upgrade
 simulation: true
-input_process: Turbo
+input_process: TurboPass
\ No newline at end of file

DaVinciExamples/tests/qmtest/debugging.qms/test_example-PrintDecayTree.qmt

@@ -16,7 +16,7 @@
 <argument name="extra_options_yaml"><text>
   evt_max: 100
   print_freq: 1
-  input_process: Turbo
+  input_process: TurboPass
   msg_svc_format: "% F%40W%S%7W%R%T %0W%M"
 </text></argument>
 <argument name="timeout"><integer>3600</integer></argument>

DaVinciExamples/tests/qmtest/tupling.qms/test_davinci_tupling_All.qmt

@@ -39,8 +39,8 @@
     lumi: false
     ntuple_file: 'DV_example_allFunctors_ntp.root'
     print_freq: 1
-    input_process: 'Spruce'
-    stream: 'default'
+    input_process: Spruce
+    input_stream: default
   </text></argument>
   <argument name="timeout"><integer>1000</integer></argument>
   <argument name="args"><set>

DaVinciExamples/tests/qmtest/tupling.qms/test_davinci_tupling_All_olddst.qmt

@@ -39,8 +39,8 @@
     lumi: false
     ntuple_file: 'DV_example_allFunctors_ntp_old.root'
     print_freq: 1
-    input_process: 'Spruce'
-    stream: 'default'
+    input_process: Spruce
+    input_stream: default
   </text></argument>
   <argument name="timeout"><integer>1000</integer></argument>
   <argument name="args"><set>

DaVinciExamples/tests/qmtest/tupling.qms/test_davinci_tupling_relation_isovariables.qmt

@@ -25,7 +25,7 @@
     print_freq: 1
     data_type: Upgrade
     simulation: true
-    input_process: Turbo
+    input_process: TurboPass
   </text></argument>
   <argument name="timeout"><integer>3600</integer></argument>
   <argument name="reference"><text>$DAVINCIEXAMPLESROOT/tests/refs/test_davinci_tupling_relation_isovariables.ref</text></argument>

DaVinciTests/python/DaVinciTests/mc/option_davinci-issue-97_bkgcat_mc-truth.yaml

@@ -5,8 +5,8 @@ annsvc_config: 'root://eoslhcb.cern.ch//eos/lhcb/wg/dpa/wp3/tests/test_davinci-i
 data_type: Upgrade
 input_type: ROOT
 simulation: true
-input_process: 'Hlt2'
-stream: 'default'
+input_process: Hlt2
+input_stream: default
 
 conddb_tag: sim-20210617-vc-mu100
 dddb_tag: dddb-20210617

DaVinciTests/tests/qmtest/functors.qms/test_thor_functors.qmt

@@ -22,7 +22,7 @@
   evt_max: -1
   print_freq: 1
   msg_svc_format: "% F%60W%S%7W%R%T %0W%M"
-  input_process: Turbo
+  input_process: TurboPass
 </text></argument>
 <argument name="timeout"><integer>3600</integer></argument>
 <argument name="args"><set>

DaVinciTutorials/options.yaml

@@ -4,7 +4,7 @@ annsvc_config: 'root://eoslhcb.cern.ch//eos/lhcb/wg/dpa/wp3/tests/hlt2_passthrou
 input_type: ROOT
 evt_max: 100
 ntuple_file: davinci_ntuple.root
-input_process: 'Turbo'
+input_process: TurboPass
 print_freq: 1
 data_type: Upgrade
 simulation: true

Phys/DaVinci/python/DaVinci/LbExec.py

@@ -28,11 +28,8 @@ class Options(DefaultOptions):
   where their keyword arguments are globally bound to the user-specified values.
   This way, users do not have to manually configure these functions themselves.
 
-  The following user-required parameters need to be set in this class:
-  - input_process (str): Input process type, see `GaudiConf.LbExec.options.InputProcessTypes` values.
-
   The optional parameters that need to be set are :
-  - stream (str): Stream name. Default is "default" (Note: for `input_process=Hlt2` the stream must be strictly empty. The default value is overwritten in this case.)
+  - input_stream (str): Stream name. Default is "default" (Note: for `input_process=Hlt2` the stream must be strictly empty. The default value is overwritten in this case.)
   - lumi (bool): Flag to store luminosity information. Default is False.
   - evt_pre_filters (dict[str,str]): Event pre-filter code. Default is None.
   - annsvc_config (str): Path to the configuration file from sprucing or Hlt2. Default is None.
@@ -40,8 +37,7 @@ class Options(DefaultOptions):
   - merge_genfsr (bool): Flag to merge the full stream record. Default is False.
   - metainfo_additional_tags: (list): Additional central tags for `PyConf.filecontent_metadata.metainfo_repos`. Default is [].
   """
-    input_process: InputProcessTypes
-    stream: Optional[str] = 'default'
+    input_stream: Optional[str] = 'default'
     lumi: bool = False
     evt_pre_filters: Optional[dict[str, str]] = None
     annsvc_config: Optional[str] = None
@@ -62,9 +58,9 @@ class Options(DefaultOptions):
       """
         input_process = values.get("input_process")
         if input_process not in {
-                InputProcessTypes.Spruce, InputProcessTypes.Turbo
+                InputProcessTypes.Spruce, InputProcessTypes.TurboPass
         }:
-            values['stream'] = ''
+            values['input_stream'] = ''
 
         return values
 
@@ -84,17 +80,17 @@ class Options(DefaultOptions):
         This way users do not have to manually configure these functions themselves.
         """
         default_raw_event.global_bind(raw_event_format=self.input_raw_format)
-        default_raw_banks.global_bind(stream=self.stream)
+        default_raw_banks.global_bind(stream=self.input_stream)
         upfront_decoder.global_bind(
-            input_process=self.input_process, stream=self.stream)
+            input_process=self.input_process, stream=self.input_stream)
         reconstruction.global_bind(input_process=self.input_process)
         get_tes_root.global_bind(input_process=self.input_process)
         get_odin.global_bind(
-            input_process=self.input_process, stream=self.stream)
-        make_odin.global_bind(stream=self.stream)
+            input_process=self.input_process, stream=self.input_stream)
+        make_odin.global_bind(stream=self.input_stream)
 
         get_hlt_reports.global_bind(
-            input_process=self.input_process, stream=self.stream)
+            input_process=self.input_process, stream=self.input_stream)
         get_mc_track_info.global_bind(input_process=self.input_process)
         with super().apply_binds():
             yield

Phys/DaVinci/python/DaVinci/algorithms.py

@@ -138,8 +138,8 @@ def apply_filters(options, algs_dict):
 
         # This filter will skip events with empty DstData but a positive line decision.
         # It will only be applied to the input_process where DstData bank is produced (Hlt2, Turbo, Spruce).
-        if options.input_process in {"Turbo", "Spruce", "Hlt2"}:
-            algs_list += [dstdata_filter(options.stream)]
+        if options.input_process in {"TurboPass", "Spruce", "Hlt2"}:
+            algs_list += [dstdata_filter(options.input_stream)]
 
         if options.evt_pre_filters:
             evt_pre_filters = []

Phys/DaVinci/tests/config/test_algorithms.py

@@ -45,14 +45,14 @@ def test_add_hlt2_filter():
         evt_max=1,
         simulation=True,
         input_process="Hlt2",
-        stream="default",
+        input_stream="default",
     )
     #Note here that we need to manually apply a bind to the PyConf functions
     # as they are not automatically configured in the pytests.
     # When running DV, the PyConf functions are globally configured and one must avoid
     # "binding" as much as possible.
     with default_raw_event.bind(raw_event_format=options.input_raw_format),\
-             get_hlt_reports.bind(input_process=options.input_process, stream=options.stream):
+             get_hlt_reports.bind(input_process=options.input_process, stream=options.input_stream):
         test_filter = create_lines_filter(
             "test_filter_{hash}", lines=['Hlt2TESTLine'])
     assert test_filter.fullname.startswith("VoidFilter/test_filter")
@@ -68,10 +68,10 @@ def test_add_spruce_filter():
         evt_max=1,
         simulation=True,
         input_process="Spruce",
-        stream="default",
+        input_stream="default",
     )
     with default_raw_event.bind(raw_event_format=options.input_raw_format),\
-             get_hlt_reports.bind(input_process=options.input_process, stream=options.stream):
+             get_hlt_reports.bind(input_process=options.input_process, stream=options.input_stream):
         test_filter = create_lines_filter(
             "test_filter_{hash}", lines=["SpruceTESTLine"])
     assert test_filter.fullname.startswith("VoidFilter/test_filter")
@@ -89,7 +89,7 @@ def test_add_void_filter():
         simulation=True,
     )
     with get_hlt_reports.bind(
-            input_process=options.input_process, stream=options.stream):
+            input_process=options.input_process, stream=options.input_stream):
         test_filter = add_filter("test_filter_{hash}", "VOIDTEST_Filter")
     assert "VoidFilter" in test_filter.fullname
 
@@ -135,16 +135,16 @@ def test_configured_funtuple():
     }
     options = Options(
         data_type="Upgrade",
-        input_process="Turbo",
+        input_process="TurboPass",
         evt_max=1,
         input_raw_format=0.5,
         simulation=True,
     )
     with default_raw_event.bind(raw_event_format=options.input_raw_format),\
-             upfront_decoder.bind(input_process=options.input_process, stream=options.stream),\
-             get_hlt_reports.bind(input_process=options.input_process, stream=options.stream),\
+             upfront_decoder.bind(input_process=options.input_process, stream=options.input_stream),\
+             get_hlt_reports.bind(input_process=options.input_process, stream=options.input_stream),\
              get_odin.bind(input_process=options.input_process,
-                           stream=options.stream):
+                           stream=options.input_stream):
         test_dict = configured_FunTuple(config)
     assert any("FunTupleBase_Particles/Tuple_TestTuple" in alg.fullname
                for alg in test_dict["TestTuple"])
@@ -163,7 +163,7 @@ def test_get_odin():
     )
     with default_raw_event.bind(raw_event_format=options.input_raw_format):
         odin = get_odin(
-            input_process=options.input_process, stream=options.stream)
+            input_process=options.input_process, stream=options.input_stream)
     assert re.fullmatch("/Event/createODIN_[0-9a-f]*/ODIN",
                         odin.location) is not None
 
@@ -177,10 +177,10 @@ def test_get_decreports():
         input_raw_format=0.5,
         evt_max=1,
         simulation=True,
-        input_process="Turbo",
-        stream="TurboSP",
+        input_process="TurboPass",
+        input_stream="TurboSP",
     )
     with default_raw_event.bind(raw_event_format=options.input_raw_format),\
-             get_hlt_reports.bind(input_process=options.input_process, stream=options.stream):
+             get_hlt_reports.bind(input_process=options.input_process, stream=options.input_stream):
         decreports = get_decreports("Hlt2")
     assert decreports.location == "/Event/Hlt2/DecReports"

doc/guide/running.rst

@@ -50,14 +50,14 @@ Also make a file named ``options.yaml`` containing:
 
 
 .. code-block:: yaml
-    
+
     input_files:
     - root://eoslhcb.cern.ch//eos/lhcb/wg/dpa/wp3/tests/hlt2_passthrough_thor_lines.dst
     annsvc_config: root://eoslhcb.cern.ch//eos/lhcb/wg/dpa/wp3/tests/hlt2_passthrough_thor_lines.tck.json
     input_type: ROOT
     evt_max: 100
     ntuple_file: davinci_ntuple.root
-    input_process: Turbo
+    input_process: TurboPass
     print_freq: 1
     data_type: Upgrade
     simulation: true