Merge branch 'master' into dependabot/github_actions/actions/setup-py…

…thon-5

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.0
+current_version = 1.2.1
 files = setup.py wfsim/__init__.py
 commit = True
 tag = True

HISTORY.md

@@ -1,3 +1,12 @@
+v1.2.1 / 2024-02-09
+===================
+* Total e_dep in sensitive volume propagated to truth (#429)
+
+v1.2.0 / 2024-01-16
+===================
+* Update readthedocs configuration (#426)
+* Move all simulation contexts to WFSim (#430)
+
 v1.1.0 / 2023-09-08
 ===================
 * Change photoionization file format to avoid pkl (#411)

extra_requirements/requirements-tests.txt

@@ -1,4 +1,4 @@
 strax>=1.6.0
 straxen>=2.2.0
-epix>=0.3.6
-git+https://github.com/XENONnT/ax_env
+epix>=0.3.8
+git+https://github.com/XENONnT/base_environment

requirements.txt

@@ -1,6 +1,7 @@
-strax>=1.1.2
+strax>=1.6.0
 utilix>=0.5.3
-straxen>=0.19.1
+straxen>=2.2.0
 uproot>=4.0.0
-epix
+epix>=0.3.7
 nestpy
+

setup.py

@@ -13,7 +13,7 @@
 
 setuptools.setup(
     name='wfsim',
-    version='1.1.0',
+    version='1.2.1',
     description='XENONnT Waveform simulator',
     author='Wfsim contributors, the XENON collaboration',
     url='https://github.com/XENONnT/wfsim',

wfsim/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.1.0"
+__version__ = "1.2.1"
 
 from .core.afterpulse import *
 from .core.pulse import *

wfsim/core/s2.py

@@ -518,7 +518,7 @@ def photon_timings(positions, n_photons_per_xy, _electron_timings, n_photons_per
         if config['s2_luminescence_model']=='simple':
             _photon_timings = S2.luminescence_timings_simple(positions, n_photons_per_xy,
                                                              config=config,
-                                                             resource=resource)
+                                                             resource=resource).astype(np.int64)
         elif config['s2_luminescence_model']=='garfield':
             confine_position=None
             if 's2_garfield_confine_position' in config:
@@ -527,21 +527,21 @@ def photon_timings(positions, n_photons_per_xy, _electron_timings, n_photons_per
             _photon_timings = S2.luminescence_timings_garfield(positions, n_photons_per_xy,
                                                                config=config,
                                                                resource=resource,
-                                                               confine_position=confine_position)
+                                                               confine_position=confine_position).astype(np.int64)
 
         elif config['s2_luminescence_model']=='garfield_gas_gap':
             _photon_timings = S2.luminescence_timings_garfield_gasgap(positions, n_photons_per_xy,
-                                                                      resource=resource)
+                                                                      resource=resource).astype(np.int64)
         else:
             raise KeyError(f"{config['s2_luminescence_model']} is not valid! Use 'simple' or 'garfield' or 'garfield_gas_gap'")
 
         # Emission Delay
-        _photon_timings += Pulse.singlet_triplet_delays(len(_photon_timings), config['singlet_fraction_gas'], config, phase)
+        _photon_timings += Pulse.singlet_triplet_delays(len(_photon_timings), config['singlet_fraction_gas'], config, phase).astype(np.int64)
 
         # Optical Propagation Delay
         if "optical_propagation" in config['s2_time_model']:
             # optical propagation splitting top and bottom
-            _photon_timings += S2.optical_propagation(_photon_channels, config, resource.s2_optical_propagation_spline)
+            _photon_timings += S2.optical_propagation(_photon_channels, config, resource.s2_optical_propagation_spline).astype(np.int64)
         elif "zero_delay" in config['s2_time_model']:
             # no optical propagation delay
             _photon_timings += np.zeros_like(_photon_timings, dtype=np.int64)
@@ -554,7 +554,7 @@ def photon_timings(positions, n_photons_per_xy, _electron_timings, n_photons_per
         # repeat for n photons per electron # Should this be before adding delays?
         _photon_timings += np.repeat(_electron_timings, n_photons_per_ele)
 
-        return _photon_timings
+        return _photon_timings.astype(np.int64)
 
     @staticmethod
     def s2_pattern_map_diffuse(n_electron, z, xy, config, resource):

wfsim/strax_interface.py

@@ -1,5 +1,6 @@
 from copy import deepcopy
 from immutabledict import immutabledict
+import sys
 import logging
 import numpy as np
 import pandas as pd
@@ -30,6 +31,7 @@
                      (('Number of quanta', 'amp'), np.int32),
                      (('Recoil type of interaction.', 'recoil'), np.int8),
                      (('Energy deposit of interaction', 'e_dep'), np.float32),
+                     (('Total energy deposit in the sensitive volume', 'tot_e'), np.float32),
                      (('Eventid like in geant4 output rootfile', 'g4id'), np.int32),
                      (('Volume id giving the detector subvolume', 'vol_id'), np.int32),
                      (('Local field [ V / cm ]', 'local_field'), np.float64),
@@ -799,8 +801,12 @@ def get_instructions(self):
                 epix.run_epix.setup(epix_config),
                 return_wfsim_instructions=True)
 
+            if len(self.instructions_epix)==0 and not 'nveto' in self.config['targets']:
+                print("The instructions are empty for TPC interactions")
+                sys.exit(0)
+
             self.g4id.append(self.instructions_epix['g4id'])
-            log.debug("Epix produced %d instructions in tpc" % (len(self.instructions_epix)))
+            log.debug("Epix produced %d instructions in TPC" % (len(self.instructions_epix)))
 
         if 'nveto' in self.config['targets']:
             self.instructions_nveto, self.nveto_channels, self.nveto_timings =\
@@ -810,7 +816,7 @@ def get_instructions(self):
 
             self.instructions_nveto = self.instructions_nveto[nv_inst_to_keep]
             self.g4id.append(self.instructions_nveto['g4id'])
-            log.debug("%d instructions were produced in nv" % (len(self.instructions_nveto)))
+            log.debug("%d instructions were produced in nVeto" % (len(self.instructions_nveto)))
 
         self.g4id = np.unique(np.concatenate(self.g4id))
         self.set_timing()