Merge pull request #772 from nu-radio/prop_from_config

read propagation settings from config file if given

NuRadioMC/SignalProp/propagation_base_class.py

@@ -25,7 +25,10 @@ class initilization
         medium: medium class
             class describing the index-of-refraction profile
         attenuation_model: string
-            signal attenuation model (so far only "SP1" is implemented)
+            if this parameter is also defined in the config file, the value from the config file
+            will be used. If not, the value from this parameter will be used.
+
+            signal attenuation model
         log_level: logging object
             specify the log level of the ray tracing class
 
@@ -36,10 +39,16 @@ class describing the index-of-refraction profile
 
             default is NOTSET (ie global control)
         n_frequencies_integration: int
-            the number of frequencies for which the frequency dependent attenuation
+            if this parameter is also defined in the config file, the value from the config file
+            will be used. If not, the value from this parameter will be used.
+
+            This parameter specifies the number of frequencies for which the frequency dependent attenuation
             length is being calculated. The attenuation length for all other frequencies
             is obtained via linear interpolation.
         n_reflections: int (default 0)
+            if this parameter is also defined in the config file, the value from the config file
+            will be used. If not, the value from this parameter will be used.
+
             in case of a medium with a reflective layer at the bottom, how many reflections should be considered
         config: nested dictionary
             loaded yaml config file
@@ -60,6 +69,19 @@ class describing the index-of-refraction profile
         self._n_reflections = n_reflections
 
         self._config = config
+        if self._config is not None:
+            if 'n_freq' in self._config['propagation']:
+                if n_frequencies_integration is not None:
+                    self.__logger.warning(f"overriding n_frequencies_integration from config file from {n_frequencies_integration} to {self._config['propagation']['n_freq']}")
+                self._n_frequencies_integration = self._config['propagation']['n_freq']
+            if 'n_reflections' in self._config['propagation']:
+                if n_reflections is not None:
+                    self.__logger.warning(f"overriding n_reflections from config file from {n_reflections} to {self._config['propagation']['n_reflections']}")
+                self._n_reflections = self._config['propagation']['n_reflections']
+            if 'attenuation_model' in self._config['propagation']:
+                if attenuation_model is not None:
+                    self.__logger.warning(f"overriding attenuation_model from config file from {attenuation_model} to {self._config['propagation']['attenuation_model']}")
+                self._attenuation_model = self._config['propagation']['attenuation_model']
         self._detector = detector
         self._max_detector_frequency = None
         if self._detector is not None:

NuRadioMC/simulation/simulation.py

@@ -1245,10 +1245,8 @@ def __init__(
 
         prop = propagation.get_propagation_module(self._config['propagation']['module'])
         self._propagator = prop(
-            self._ice, self._config['propagation']['attenuation_model'],
+            self._ice,
             log_level=self._log_level_ray_propagation,
-            n_frequencies_integration=int(self._config['propagation']['n_freq']),
-            n_reflections=int(self._config['propagation']['n_reflections']),
             config=self._config,
             detector=self._det
         )