reboost 0.8.2__tar.gz → 0.8.4__tar.gz

reboost-0.8.4/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: reboost
+Version: 0.8.4
+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
+License-Expression: GPL-3.0
+Project-URL: Homepage, https://github.com/legend-exp/reboost
+Project-URL: Bug Tracker, https://github.com/legend-exp/reboost/issues
+Project-URL: Discussions, https://github.com/legend-exp/reboost/discussions
+Project-URL: Changelog, https://github.com/legend-exp/reboost/releases
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hdf5plugin
+Requires-Dist: colorlog
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: numba>=0.60
+Requires-Dist: legend-pydataobj>=1.15.1
+Requires-Dist: legend-pygeom-optics>=0.15.0
+Requires-Dist: legend-pygeom-tools>=0.0.26
+Requires-Dist: legend-pygeom-hpges
+Requires-Dist: hist
+Requires-Dist: dbetto
+Requires-Dist: particle
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: pygama
+Requires-Dist: pyg4ometry
+Provides-Extra: all
+Requires-Dist: reboost[docs,test]; extra == "all"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pre-commit; extra == "test"
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: legend-pygeom-hpges; extra == "test"
+Requires-Dist: pylegendtestdata>=0.6; extra == "test"
+Dynamic: license-file
+
+# reboost
+
+[![PyPI](https://img.shields.io/pypi/v/reboost?logo=pypi)](https://pypi.org/project/reboost/)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/reboost.svg)](https://anaconda.org/conda-forge/reboost)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/legend-exp/reboost?logo=git)
+[![GitHub Workflow Status](https://img.shields.io/github/checks-status/legend-exp/reboost/main?label=main%20branch&logo=github)](https://github.com/legend-exp/reboost/actions)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Codecov](https://img.shields.io/codecov/c/github/legend-exp/reboost?logo=codecov)](https://app.codecov.io/gh/legend-exp/reboost)
+![GitHub issues](https://img.shields.io/github/issues/legend-exp/reboost?logo=github)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/legend-exp/reboost?logo=github)
+![License](https://img.shields.io/github/license/legend-exp/reboost)
+[![Read the Docs](https://img.shields.io/readthedocs/reboost?logo=readthedocs)](https://reboost.readthedocs.io)
+
+_reboost_ is a package to post-process
+[remage](https://remage.readthedocs.io/en/stable/) simulations. Post processing
+is the step of applying a detector response model to the (idealised) _remage_ /
+_Geant4_ simulations to ''boost" them allowing comparison to data.
+
+_reboost_ provides tools to:
+
+- apply a HPGe detector response model to the simulations,
+- dedicated tools to generate optical maps,
+- functionality to control the full post-processing chain with configuration
+  files.
+
+For more information see our dedicated
+[documentation](https://reboost.readthedocs.io/en/stable/)!

{reboost-0.8.2 → reboost-0.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-    "setuptools>=61.2",
+    "setuptools>=77",
     "setuptools_scm[toml]>=7"
 ]
 build-backend = "setuptools.build_meta"
@@ -17,11 +17,11 @@ maintainers = [
     { name = "The LEGEND Collaboration" },
 ]
 readme = "README.md"
-license.file = "LICENSE"
+license = "GPL-3.0"
+license-files = ["LICENSE"]
 classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Operating System :: MacOS",
     "Operating System :: POSIX",
     "Operating System :: Unix",
@@ -38,8 +38,8 @@ dependencies = [
     "scipy",
     "numba >=0.60",
     "legend-pydataobj >=1.15.1",
-    "legend-pygeom-optics >=0.12.0",
-    "legend-pygeom-tools >=0.0.11",
+    "legend-pygeom-optics >=0.15.0",
+    "legend-pygeom-tools >=0.0.26",
     "legend-pygeom-hpges",
     "hist",
     "dbetto",
@@ -87,9 +87,6 @@ reboost         = "reboost.cli:cli"
 [tool.setuptools]
 include-package-data = true
 zip-safe = false
-license-files = [
-    "LICENSE",
-]
 
 [tool.setuptools.package-dir]
 "" = "src"

reboost-0.8.4/src/reboost/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.8.2'
-__version_tuple__ = version_tuple = (0, 8, 2)
+__version__ = version = '0.8.4'
+__version_tuple__ = version_tuple = (0, 8, 4)
 
-__commit_id__ = commit_id = 'gc0299ec86'
+__commit_id__ = commit_id = 'g974fc1b03'

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/build_hit.py

@@ -42,7 +42,7 @@ A :func:`build_hit` to parse the following configuration file:
           # iteration of the for loop over input tables (i.e. detectors)
           detector_objects:
              # The following assumes that the detector metadata is stored in the GDML file
-             pyobj: legendhpges.make_hpge(pygeomtools.get_sensvol_metadata(OBJECTS.geometry, DETECTOR))
+             pyobj: pygeomhpges.make_hpge(pygeomtools.get_sensvol_metadata(OBJECTS.geometry, DETECTOR))
              phyvol: OBJECTS.geometry.physical_volume_dict[DETECTOR]
              drift_time_map: lgdo.lh5.read(DETECTOR, ARGS.dtmap_file)
 

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/hpge/surface.py

@@ -3,9 +3,9 @@ from __future__ import annotations
 import logging
 
 import awkward as ak
-import legendhpges
 import numba
 import numpy as np
+import pygeomhpges
 from lgdo import VectorOfVectors
 from lgdo.types import LGDO
 from numpy.typing import ArrayLike
@@ -18,7 +18,7 @@ def distance_to_surface(
     positions_x: VectorOfVectors,
     positions_y: VectorOfVectors,
     positions_z: VectorOfVectors,
-    hpge: legendhpges.base.HPGe,
+    hpge: pygeomhpges.base.HPGe,
     det_pos: ArrayLike,
     *,
     surface_type: str | None = None,

reboost-0.8.4/src/reboost/optmap/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from .cli import optical_cli
+
+if __name__ == "__main__":
+    optical_cli()

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/optmap/convolve.py

@@ -4,14 +4,14 @@ import logging
 from typing import NamedTuple
 
 import awkward as ak
-import legendoptics.scintillate as sc
 import numba
 import numpy as np
-from legendoptics import fibers, lar, pen
+import pygeomoptics.scintillate as sc
 from lgdo import lh5
 from lgdo.types import Histogram
 from numba import njit
 from numpy.typing import NDArray
+from pygeomoptics import fibers, lar, pen
 
 from .numba_pdg import numba_pdgid_funcs
 
@@ -32,7 +32,7 @@ class OptmapForConvolve(NamedTuple):
 
 def open_optmap(optmap_fn: str) -> OptmapForConvolve:
     dets = lh5.ls(optmap_fn, "/channels/")
-    detidx = np.arange(0, dets.shape[0])
+    detidx = np.arange(0, len(dets))
 
     optmap_all = lh5.read("/all/prob", optmap_fn)
     assert isinstance(optmap_all, Histogram)
@@ -61,14 +61,14 @@ def open_optmap(optmap_fn: str) -> OptmapForConvolve:
             raise ValueError(msg)
     else:
         detidx = np.array([OPTMAP_ANY_CH])
-        dets = np.array(["all"])
+        dets = ["all"]
 
     # check the exponent from the optical map file
     if "_hitcounts_exp" in lh5.ls(optmap_fn):
         msg = "found _hitcounts_exp which is not supported any more"
         raise RuntimeError(msg)
 
-    dets = [d.replace("/channels/", "") for d in dets]
+    dets = np.array([d.replace("/channels/", "") for d in dets])
 
     return OptmapForConvolve(dets, detidx, optmap_edges, ow)
 

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/optmap/evt.py

@@ -131,9 +131,9 @@ def get_optical_detectors_from_geom(geom_fn) -> dict[int, str]:
     import pygeomtools
 
     geom_registry = pyg4ometry.gdml.Reader(geom_fn).getRegistry()
-    detectors = pygeomtools.get_all_sensvols(geom_registry)
+    detectors = pygeomtools.get_all_sensvols(geom_registry, type_filter="optical")
     return OrderedDict(
-        [(d.uid, name) for name, d in detectors.items() if d.detector_type == "optical"]
+        [(d.uid, d.ntuple_name if d.ntuple_name else name) for name, d in detectors.items()]
     )
 
 

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/optmap/mapview.py

@@ -95,7 +95,7 @@ def _read_data(
     histogram_choice: str = "prob",
 ) -> tuple[tuple[NDArray], NDArray]:
     histogram = histogram_choice if histogram_choice != "prob_unc_rel" else "prob"
-    detid = f"channels/{detid}" if detid != all and not detid.startswith("channels/") else detid
+    detid = f"channels/{detid}" if detid != "all" and not detid.startswith("channels/") else detid
 
     optmap_all = lh5.read(f"/{detid}/{histogram}", optmap_fn)
     optmap_edges = tuple([b.edges for b in optmap_all.binning])

reboost-0.8.4/src/reboost/spms/__init__.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from .pe import detected_photoelectrons, emitted_scintillation_photons, load_optmap, load_optmap_all
+
+__all__ = [
+    "detected_photoelectrons",
+    "emitted_scintillation_photons",
+    "load_optmap",
+    "load_optmap_all",
+]

{reboost-0.8.2 → reboost-0.8.4}/src/reboost/spms/pe.py

@@ -140,8 +140,8 @@ def detected_photoelectrons(
     """
     hits = ak.Array(
         {
-            "num_scint_ph": num_scint_ph,
-            "particle": particle,
+            "num_scint_ph": units_conv_ak(num_scint_ph, "dimensionless"),
+            "particle": units_conv_ak(particle, "dimensionless"),
             "time": units_conv_ak(time, "ns"),
             "xloc": units_conv_ak(xloc, "m"),
             "yloc": units_conv_ak(yloc, "m"),
@@ -171,7 +171,12 @@ def emitted_scintillation_photons(
     material
         scintillating material name.
     """
-    hits = ak.Array({"edep": units_conv_ak(edep, "keV"), "particle": particle})
+    hits = ak.Array(
+        {
+            "edep": units_conv_ak(edep, "keV"),
+            "particle": units_conv_ak(particle, "dimensionless"),
+        }
+    )
 
     scint_mat_params = convolve._get_scint_params(material)
     ph = convolve.iterate_stepwise_depositions_scintillate(hits, scint_mat_params)

reboost-0.8.4/src/reboost.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: reboost
+Version: 0.8.4
+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
+License-Expression: GPL-3.0
+Project-URL: Homepage, https://github.com/legend-exp/reboost
+Project-URL: Bug Tracker, https://github.com/legend-exp/reboost/issues
+Project-URL: Discussions, https://github.com/legend-exp/reboost/discussions
+Project-URL: Changelog, https://github.com/legend-exp/reboost/releases
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hdf5plugin
+Requires-Dist: colorlog
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: numba>=0.60
+Requires-Dist: legend-pydataobj>=1.15.1
+Requires-Dist: legend-pygeom-optics>=0.15.0
+Requires-Dist: legend-pygeom-tools>=0.0.26
+Requires-Dist: legend-pygeom-hpges
+Requires-Dist: hist
+Requires-Dist: dbetto
+Requires-Dist: particle
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: pygama
+Requires-Dist: pyg4ometry
+Provides-Extra: all
+Requires-Dist: reboost[docs,test]; extra == "all"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pre-commit; extra == "test"
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: legend-pygeom-hpges; extra == "test"
+Requires-Dist: pylegendtestdata>=0.6; extra == "test"
+Dynamic: license-file
+
+# reboost
+
+[![PyPI](https://img.shields.io/pypi/v/reboost?logo=pypi)](https://pypi.org/project/reboost/)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/reboost.svg)](https://anaconda.org/conda-forge/reboost)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/legend-exp/reboost?logo=git)
+[![GitHub Workflow Status](https://img.shields.io/github/checks-status/legend-exp/reboost/main?label=main%20branch&logo=github)](https://github.com/legend-exp/reboost/actions)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Codecov](https://img.shields.io/codecov/c/github/legend-exp/reboost?logo=codecov)](https://app.codecov.io/gh/legend-exp/reboost)
+![GitHub issues](https://img.shields.io/github/issues/legend-exp/reboost?logo=github)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/legend-exp/reboost?logo=github)
+![License](https://img.shields.io/github/license/legend-exp/reboost)
+[![Read the Docs](https://img.shields.io/readthedocs/reboost?logo=readthedocs)](https://reboost.readthedocs.io)
+
+_reboost_ is a package to post-process
+[remage](https://remage.readthedocs.io/en/stable/) simulations. Post processing
+is the step of applying a detector response model to the (idealised) _remage_ /
+_Geant4_ simulations to ''boost" them allowing comparison to data.
+
+_reboost_ provides tools to:
+
+- apply a HPGe detector response model to the simulations,
+- dedicated tools to generate optical maps,
+- functionality to control the full post-processing chain with configuration
+  files.
+
+For more information see our dedicated
+[documentation](https://reboost.readthedocs.io/en/stable/)!

{reboost-0.8.2 → reboost-0.8.4}/src/reboost.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ LICENSE
 README.md
 pyproject.toml
 src/reboost/__init__.py
+src/reboost/__main__.py
 src/reboost/_version.py
 src/reboost/build_evt.py
 src/reboost/build_glm.py
@@ -31,6 +32,7 @@ src/reboost/math/__init__.py
 src/reboost/math/functions.py
 src/reboost/math/stats.py
 src/reboost/optmap/__init__.py
+src/reboost/optmap/__main__.py
 src/reboost/optmap/cli.py
 src/reboost/optmap/convolve.py
 src/reboost/optmap/create.py

{reboost-0.8.2 → reboost-0.8.4}/src/reboost.egg-info/requires.txt

@@ -4,8 +4,8 @@ numpy
 scipy
 numba>=0.60
 legend-pydataobj>=1.15.1
-legend-pygeom-optics>=0.12.0
-legend-pygeom-tools>=0.0.11
+legend-pygeom-optics>=0.15.0
+legend-pygeom-tools>=0.0.26
 legend-pygeom-hpges
 hist
 dbetto

{reboost-0.8.2 → reboost-0.8.4}/tests/hit/configs/hit_config.yaml

@@ -13,7 +13,7 @@ processing_groups:
       meta: dbetto.AttrsDict(pygeomtools.get_sensvol_metadata(OBJECTS.geometry,
         OBJECTS.user_pars[DETECTOR].name ))
       pyobj:
-        legendhpges.make_hpge(pygeomtools.get_sensvol_metadata(OBJECTS.geometry,OBJECTS.user_pars[DETECTOR].name),
+        pygeomhpges.make_hpge(pygeomtools.get_sensvol_metadata(OBJECTS.geometry,OBJECTS.user_pars[DETECTOR].name),
         registry = OBJECTS.reg)
       phyvol: OBJECTS.geometry.physicalVolumeDict[OBJECTS.user_pars[DETECTOR].name]
       det_pars: OBJECTS.user_pars[DETECTOR]

{reboost-0.8.2 → reboost-0.8.4}/tests/hit/configs/spms.yaml

@@ -1,5 +1,6 @@
 objects:
   spms: "['S001', 'S002']"
+  optmap_test: reboost.spms.load_optmap_all(ARGS.optmap_path)
 
 processing_groups:
   - name: spms

{reboost-0.8.2 → reboost-0.8.4}/tests/hit/test_build_hit.py

@@ -333,6 +333,7 @@ def test_spms(test_gen_lh5_scint, tmptestdir):
     m.create_probability()
     m.write_lh5(map_file, "channels/S001", "overwrite_file")
     m.write_lh5(map_file, "channels/S002", "write_safe")
+    m.write_lh5(map_file, "all", "write_safe")
 
     outfile = f"{tmptestdir}/spms_hit.lh5"
     reboost.build_hit(

{reboost-0.8.2 → reboost-0.8.4}/tests/hpge/simulation/make_geom.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-import legendhpges as hpges
 import numpy as np
 import pyg4ometry as pg4
+import pygeomhpges as hpges
 from legendtestdata import LegendTestData
 
 ldata = LegendTestData()

{reboost-0.8.2 → reboost-0.8.4}/tests/hpge/test_surface.py

@@ -4,10 +4,10 @@ import awkward as ak
 import numpy as np
 import pyg4ometry
 import pytest
-from legendhpges import make_hpge
 from legendtestdata import LegendTestData
 from lgdo import types
 from lgdo.types import VectorOfVectors
+from pygeomhpges import make_hpge
 
 from reboost.hpge.surface import distance_to_surface, get_surface_response
 

{reboost-0.8.2 → reboost-0.8.4}/tests/test_core.py

@@ -4,9 +4,9 @@ import json
 from pathlib import Path
 
 import awkward as ak
-import legendhpges
 import numpy as np
 import pyg4ometry as pg4
+import pygeomhpges
 import pygeomtools
 import pytest
 from dbetto import AttrsDict
@@ -27,7 +27,7 @@ def test_data_configs():
 def make_gdml(test_data_configs):
     reg = pg4.geant4.Registry()
     meta = f"{test_data_configs}/C99000A.json"
-    hpge = legendhpges.make_hpge(meta, registry=reg)
+    hpge = pygeomhpges.make_hpge(meta, registry=reg)
 
     world_s = pg4.geant4.solid.Orb("World_s", 20, registry=reg, lunit="cm")
     world_l = pg4.geant4.LogicalVolume(world_s, "G4_Galactic", "World", registry=reg)
@@ -116,7 +116,7 @@ def test_get_objects(test_data_configs, make_gdml):
     # get legend-test data
     # check if we can make a HPGe
     path = test_data_configs + r"/{DETECTOR}"
-    expression = f"legendhpges.make_hpge(f'{path}.json',registry = OBJECTS.reg)"
+    expression = f"pygeomhpges.make_hpge(f'{path}.json',registry = OBJECTS.reg)"
     assert reboost.core.evaluate_object(expression, {"DETECTOR": "C99000A", "OBJECTS": objects})
 
     # test construction of the global objects
@@ -144,7 +144,7 @@ def test_get_objects(test_data_configs, make_gdml):
     # test getting detector objects
     expressions = {
         "meta": "pygeomtools.get_sensvol_metadata(OBJECTS.geometry, DETECTOR)",
-        "hpge": "legendhpges.make_hpge(pygeomtools.get_sensvol"
+        "hpge": "pygeomhpges.make_hpge(pygeomtools.get_sensvol"
         "_metadata(OBJECTS.geometry, DETECTOR),registry = OBJECTS.reg,name=ARGS.name)",
     }
 

{reboost-0.8.2 → reboost-0.8.4}/tests/test_utils.py

@@ -84,13 +84,13 @@ def test_get_function_string():
 
     # try a more compliated expression
     expression = (
-        "legendhpges.make_hpge(pygeomtools.get_sensvol"
+        "pygeomhpges.make_hpge(pygeomtools.get_sensvol"
         "_metadata(OBJECTS.geometry, DETECTOR),registry = OBJECT.reg,name=ARGS.name)"
     )
 
     func_string, globals_dict = get_function_string(expression)
 
-    assert list(globals_dict.keys()) == ["legendhpges", "pygeomtools"]
+    assert list(globals_dict.keys()) == ["pygeomhpges", "pygeomtools"]
 
 
 def test_merge_dicts():