Added NR yields, updated defaut yields treatment (#357)

* Added NR yields, updated defaut yields treatment

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix typo

* Update test simulation config from sr1_dev to sr2_dev

* Update simulation config file for microphysics context

* env var in tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix precommit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Carlo Fuselli <cfuselli@nikhef.nl>

Author: 3 people

.github/workflows/pytest.yml

@@ -102,6 +102,8 @@ jobs:
         env:
           TEST_MONGO_URI: 'mongodb://localhost:27017/'
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FUSE_TEST_SIMULATION_CONFIG: ${{ matrix.dependency-version == 'lowest' && 'sr1_dev' || 'sr2_dev' }}
+
         if: env.HAVE_ACCESS_TO_SECRETS != null
         run: |
           coverage run --source=fuse -m pytest --durations 0 -v

fuse/context.py

@@ -114,7 +114,7 @@
 
 def microphysics_context(
     output_folder="./fuse_data",
-    simulation_config_file="fuse_config_nt_sr1_dev.json",
+    simulation_config_file="fuse_config_nt_sr2_dev.json",
     clustering_method="dbscan",
     extra_plugins=[],
 ):

fuse/plugins/micro_physics/yields.py

@@ -18,7 +18,7 @@ class NestYields(FuseBasePlugin):
     """Plugin that calculates the number of photons, electrons and excitons
     produced by energy deposit using nestpy."""
 
-    __version__ = "0.2.3"
+    __version__ = "0.3.0"
 
     depends_on = ("interactions_in_roi", "electric_field_values")
     provides = "quanta"
@@ -51,12 +51,20 @@ class NestYields(FuseBasePlugin):
         default="take://resource://"
         "SIMULATION_CONFIG_FILE.json?&fmt=json"
         "&take=nest_er_yields_parameters",
-        type=list,
+        type=(int, list),
         help="Set to modify default NEST ER yields parameters. Use -1 to keep default value. \
         From NEST code https://github.com/NESTCollaboration/nest/blob/v2.4.0/src/NEST.cpp \
         Used in the calcuations of BetaYieldsGR.",
     )
 
+    nest_nr_yields_parameters = straxen.URLConfig(
+        default="take://resource://"
+        "SIMULATION_CONFIG_FILE.json?&fmt=json"
+        "&take=nest_nr_yields_parameters",
+        type=(int, list),
+        help="Set to modify default NEST NR yields parameters. Use -1 to keep default value.",
+    )
+
     fix_gamma_yield_field = straxen.URLConfig(
         default=-1.0,
         help="Field in V/cm to use for NEST gamma yield calculation. Only used if set to > 0.",
@@ -77,10 +85,26 @@ def setup(self):
         self.vectorized_get_quanta = np.vectorize(self.get_quanta)
         self.updated_nest_width_parameters = self.update_nest_width_parameters()
 
-        # Set the elements of the list so we do not run into problems with the vectorized function
-        self.nest_er_yields_parameters_list = [
-            float(element) for element in self.nest_er_yields_parameters
-        ]
+        # Change NR and ER yields to best fit:
+        if hasattr(self.nest_er_yields_parameters, "__len__"):
+            # Set the elements of the list
+            # so we do not run into problems with the vectorized function
+            self.nest_er_yields_parameters_list = [
+                float(element) for element in self.nest_er_yields_parameters
+            ]
+        elif self.nest_er_yields_parameters == -1:
+            self.nest_er_yields_parameters_list = nestpy.default_er_yields_params()
+        else:
+            raise ValueError("Not supported setting for nest_er_yields_parameters!")
+
+        if hasattr(self.nest_nr_yields_parameters, "__len__"):
+            self.nest_nr_yields_parameters_list = [
+                float(element) for element in self.nest_nr_yields_parameters
+            ]
+        elif self.nest_nr_yields_parameters == -1:
+            self.nest_nr_yields_parameters_list = nestpy.default_nr_yields_params()
+        else:
+            raise ValueError("Not supported setting for nest_nr_yields_parameters!")
 
     def update_nest_width_parameters(self):
 
@@ -207,6 +231,7 @@ def get_yields_from_NEST(self, en, model, e_field, A, Z, density):
             Z=Z,
             density=density,
             ERYieldsParam=self.nest_er_yields_parameters_list,
+            nuisance_parameters=self.nest_nr_yields_parameters_list,
         )
 
         return yields_result

tests/_utils.py

@@ -1,8 +1,11 @@
 import pandas as pd
 import numpy as np
+import os
 
 test_root_file_name = "test_cryo_neutrons_tpc-nveto.root"
-test_simulation_config = "sr1_dev"
+
+# This environment variable is set in the CI configuration
+test_simulation_config = os.getenv("FUSE_TEST_SIMULATION_CONFIG", "sr2_dev")
 
 
 def build_random_instructions(n):