reboost 0.6.1__tar.gz → 0.6.2__tar.gz

{reboost-0.6.1 → reboost-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reboost
-Version: 0.6.1
+Version: 0.6.2
 Summary: New LEGEND Monte-Carlo simulation post-processing
 Author-email: Manuel Huber <info@manuelhu.de>, Toby Dixon <toby.dixon.23@ucl.ac.uk>, Luigi Pertoldi <gipert@pm.me>
 Maintainer: The LEGEND Collaboration

{reboost-0.6.1 → reboost-0.6.2}/src/reboost/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.6.1'
-__version_tuple__ = version_tuple = (0, 6, 1)
+__version__ = version = '0.6.2'
+__version_tuple__ = version_tuple = (0, 6, 2)

{reboost-0.6.1 → reboost-0.6.2}/src/reboost/build_hit.py

@@ -235,6 +235,7 @@ def build_hit(
     files = utils.get_file_dict(stp_files=stp_files, glm_files=glm_files, hit_files=hit_files)
 
     output_tables = {}
+    output_tables_names = set()
 
     # iterate over files
     for file_idx, (stp_file, glm_file) in enumerate(zip(files.stp, files.glm)):
@@ -363,16 +364,12 @@ def build_hit(
                         # now write
                         if files.hit[file_idx] is not None:
                             # get modes to write with
-                            new_hit_file = (file_idx == 0) or (
-                                files.hit[file_idx] != files.hit[file_idx - 1]
-                            )
-
                             wo_mode = utils.get_wo_mode(
                                 group=group_idx,
                                 out_det=out_det_idx,
                                 in_det=in_det_idx,
                                 chunk=chunk_idx,
-                                new_hit_file=new_hit_file,
+                                new_hit_file=utils.is_new_hit_file(files, file_idx),
                                 overwrite=overwrite,
                             )
                             # write the file
@@ -390,6 +387,8 @@ def build_hit(
                                 hit_table, output_tables[out_detector]
                             )
 
+                        output_tables_names.add(out_detector)
+
         # forward some data, if requested
         # possible improvement: iterate over data if it's a lot
         if "forward" in config and files.hit[file_idx] is not None:
@@ -400,12 +399,16 @@ def build_hit(
 
             for obj in obj_list:
                 try:
+                    wo_mode = utils.get_wo_mode_forwarded(
+                        output_tables_names, utils.is_new_hit_file(files, file_idx), overwrite
+                    )
                     lh5.write(
                         lh5.read(obj, stp_file),
                         obj,
                         files.hit[file_idx],
-                        wo_mode="write_safe" if file_idx == 0 else "append",
+                        wo_mode=wo_mode,
                     )
+                    output_tables_names.add(obj)
                 except LH5EncodeError as e:
                     msg = f"cannot forward object {obj} as it has been already processed by reboost"
                     raise RuntimeError(msg) from e

{reboost-0.6.1 → reboost-0.6.2}/src/reboost/utils.py

@@ -51,7 +51,9 @@ def get_wo_mode(
     chunk
         the chunk index
     new_hit_file
-        a flag of whether we are writing a new hit file
+        a flag of whether we are writing a new hit file. This does not indicate whether
+        the file already exists on disk, but whether the file name is different from the
+        last written chunk for this detector.
     overwrite
         a flag of whether to overwrite the old file.
 
@@ -75,6 +77,49 @@ def get_wo_mode(
     return "append"
 
 
+def get_wo_mode_forwarded(
+    written_tables: set[str], new_hit_file: bool, overwrite: bool = False
+) -> str:
+    """Get the mode for lh5 file writing for forwarded tables tahat will be copied without chunking.
+
+    If we are writing a new output file and no other tables had been written yet, then
+    the mode "overwrite_file" is used if the overwrite flag is set, otherwise the mode
+    "write_safe" is used.
+
+    Otherwise "append" is used.
+
+    Parameters
+    ----------
+    written_tables
+        a set of already written table names, also including other table names of
+        non-forwarded (i.e. processed) tables.
+    new_hit_file
+        a flag of whether we are writing a new hit file. This does not indicate whether
+        the file already exists on disk, but whether the file name is different from the
+        last written chunk for this forwarded table.
+    overwrite
+        a flag of whether to overwrite the old file.
+
+    Returns
+    -------
+    the mode for IO
+    """
+    if not new_hit_file:
+        return "append"
+    if overwrite and len(written_tables) == 0:
+        return "overwrite_file"
+    return "write_safe"
+
+
+def is_new_hit_file(files: AttrsDict, file_idx: int) -> bool:
+    """Return whether the hit file with the given index is a "new" hit file.
+
+    A new file is either the first file written, or when the previous file index has a
+    different file name.
+    """
+    return (file_idx == 0) or (files.hit[file_idx] != files.hit[file_idx - 1])
+
+
 def get_file_dict(
     stp_files: list[str] | str,
     glm_files: list[str] | str | None,

{reboost-0.6.1 → reboost-0.6.2}/src/reboost.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reboost
-Version: 0.6.1
+Version: 0.6.2
 Summary: New LEGEND Monte-Carlo simulation post-processing
 Author-email: Manuel Huber <info@manuelhu.de>, Toby Dixon <toby.dixon.23@ucl.ac.uk>, Luigi Pertoldi <gipert@pm.me>
 Maintainer: The LEGEND Collaboration

{reboost-0.6.1 → reboost-0.6.2}/src/reboost.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ tests/glm/test_build_glm.py
 tests/hit/test_build_hit.py
 tests/hit/configs/args.yaml
 tests/hit/configs/basic.yaml
+tests/hit/configs/foward_only.yaml
 tests/hit/configs/geom.gdml
 tests/hit/configs/hit_config.yaml
 tests/hit/configs/pars.yaml

reboost-0.6.2/tests/hit/configs/foward_only.yaml

@@ -0,0 +1,9 @@
+processing_groups:
+  - name: all
+
+    detector_mapping: []
+
+    hit_table_layout: "reboost.shape.group.group_by_time(STEPS, 10)"
+
+forward:
+  - /vtx

{reboost-0.6.1 → reboost-0.6.2}/tests/hit/test_build_hit.py

@@ -107,6 +107,24 @@ def test_reshape(test_gen_lh5_flat, tmptestdir):
     assert lh5.read("vtx", outfile) == Table({"evtid": Array([0, 1])})
 
 
+def test_only_forward(test_gen_lh5_flat, tmptestdir):
+    outfile = f"{tmptestdir}/basic_hit_foward_only.lh5"
+
+    for _ in range(2):  # test that overwriting the output file works.
+        reboost.build_hit(
+            f"{Path(__file__).parent}/configs/foward_only.yaml",
+            args={},
+            stp_files=test_gen_lh5_flat,
+            glm_files=None,
+            hit_files=outfile,
+            out_field="stp",
+            overwrite=True,
+        )
+
+    # check the outputs
+    assert lh5.read("vtx", outfile) == Table({"evtid": Array([0, 1])})
+
+
 def test_basic(test_gen_lh5, tmptestdir):
     outfile = f"{tmptestdir}/basic_hit.lh5"
 

{reboost-0.6.1 → reboost-0.6.2}/tests/test_utils.py

@@ -17,6 +17,7 @@ from reboost.utils import (
     get_function_string,
     get_table_names,
     get_wo_mode,
+    get_wo_mode_forwarded,
     merge_dicts,
 )
 
@@ -125,6 +126,13 @@ def test_wo_mode():
     assert get_wo_mode(0, 0, 1, 1, True, overwrite=False) == "append"
     assert get_wo_mode(0, 0, 1, 0, False, overwrite=False) == "append"
 
+    assert get_wo_mode_forwarded({}, True, overwrite=True) == "overwrite_file"
+    assert get_wo_mode_forwarded({"a"}, True, overwrite=True) == "write_safe"
+    assert get_wo_mode_forwarded({}, True, overwrite=False) == "write_safe"
+    assert get_wo_mode_forwarded({"a"}, True, overwrite=False) == "write_safe"
+    assert get_wo_mode_forwarded({}, False, overwrite=False) == "append"
+    assert get_wo_mode_forwarded({"a"}, False, overwrite=False) == "append"
+
 
 def test_get_files_dict():
     # simplest case - all are str