gammasimtools 0.25.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

simtools/simtel/simulator_ray_tracing.py

@@ -5,10 +5,10 @@ from collections import namedtuple
 
 import astropy.units as u
 
+from simtools import settings
 from simtools.io import io_handler
 from simtools.runners.simtel_runner import SimtelRunner
 from simtools.utils import names
-from simtools.utils.general import clear_default_sim_telarray_cfg_directories
 
 # pylint: disable=no-member
 # The line above is needed because there are members which are created
@@ -27,8 +27,6 @@ class SimulatorRayTracing(SimtelRunner):
         site model
     label: str
         label used for output file naming.
-    simtel_path: str or Path
-        Location of sim_telarray installation.
     config_data: namedtuple
         namedtuple containing the configurable parameters as values (expected units in
         brackets): zenith_angle (deg), off_axis_angle (deg), source_distance (km),
@@ -43,7 +41,6 @@ class SimulatorRayTracing(SimtelRunner):
         telescope_model,
         site_model,
         label=None,
-        simtel_path=None,
         config_data=None,
         force_simulate=False,
         test=False,
@@ -52,7 +49,7 @@ class SimulatorRayTracing(SimtelRunner):
         self._logger = logging.getLogger(__name__)
         self._logger.debug("Init SimulatorRayTracing")
 
-        super().__init__(label=label, simtel_path=simtel_path)
+        super().__init__(label=label)
 
         self.telescope_model = telescope_model
         self.site_model = site_model
@@ -69,6 +66,8 @@ class SimulatorRayTracing(SimtelRunner):
         self._rep_number = 0
         self.runs_per_set = 1 if self.config.single_mirror_mode else 20
         self.photons_per_run = 100000 if not test else 5000
+        self._single_pixel_camera_file = None
+        self._funnel_file = None
 
         self._load_required_files(force_simulate)
 
@@ -83,10 +82,6 @@ class SimulatorRayTracing(SimtelRunner):
         force_simulate: bool
             Remove existing files and force re-running of the ray-tracing simulation.
         """
-        # This file is not actually needed and does not exist in simtools.
-        # It is required as CORSIKA input file to sim_telarray
-        self._corsika_file = self._simtel_path.joinpath("run9991.corsika.gz")
-
         # Loop to define and remove existing files.
         # Files will be named _base_file = self.__dict__['_' + base + 'File']
         for base_name in ["stars", "photons", "log"]:
@@ -112,12 +107,13 @@ class SimulatorRayTracing(SimtelRunner):
             self.__dict__["_" + base_name + "_file"] = file
 
         if not file.exists() or force_simulate:
+            config_file_path = self.telescope_model.get_config_file_path(label=self.label)
             # Adding header to photon list file.
             with self._photons_file.open("w", encoding="utf-8") as file:
                 file.write(f"#{50 * '='}\n")
                 file.write("# List of photons for RayTracing simulations\n")
                 file.write(f"#{50 * '='}\n")
-                file.write(f"# config_file = {self.telescope_model.config_file_path}\n")
+                file.write(f"# config_file = {config_file_path}\n")
                 file.write(f"# zenith_angle [deg] = {self.config.zenith_angle}\n")
                 file.write(f"# off_axis_angle [deg] = {self.config.off_axis_angle}\n")
                 file.write(f"# source_distance [km] = {self.config.source_distance}\n")
@@ -136,15 +132,20 @@ class SimulatorRayTracing(SimtelRunner):
 
         if self.config.single_mirror_mode:
             self._logger.debug("For single mirror mode, need to prepare the single pixel camera.")
-            self._write_out_single_pixel_camera_file()
+            self._write_out_single_pixel_camera_files()
 
-    def _make_run_command(self, run_number=None, input_file=None):  # pylint: disable=unused-argument
+    def make_run_command(self, run_number=None, input_file=None):  # pylint: disable=unused-argument
         """
         Generate sim_telarray run command. Export sim_telarray configuration file(s).
 
         The run_number and input_file parameters are not relevant for the ray tracing simulation.
         """
-        self.telescope_model.write_sim_telarray_config_file(additional_models=self.site_model)
+        self.telescope_model.write_sim_telarray_config_file(
+            additional_models=self.site_model,
+            label=self.label,
+        )
+
+        config_file_path = self.telescope_model.get_config_file_path(label=self.label)
 
         if self.config.single_mirror_mode:
             # Note: no mirror length defined for dual-mirror telescopes
@@ -152,54 +153,56 @@ class SimulatorRayTracing(SimtelRunner):
                 self.telescope_model.get_parameter_value("mirror_focal_length")
             )
 
-        # RayTracing
-        command = str(self._simtel_path.joinpath("sim_telarray/bin/sim_telarray"))
-        command += f" -c {self.telescope_model.config_file_path}"
-        command += f" -I{self.telescope_model.config_file_directory}"
-        command += super().get_config_option("random_state", "none")
-        command += super().get_config_option("IMAGING_LIST", str(self._photons_file))
-        command += super().get_config_option("stars", str(self._stars_file))
-        command += super().get_config_option(
-            "altitude", self.site_model.get_parameter_value("corsika_observation_level")
-        )
-        command += super().get_config_option(
-            "telescope_theta",
-            self.config.zenith_angle + self.config.off_axis_angle,
-        )
-        command += super().get_config_option("star_photons", str(self.photons_per_run))
-        command += super().get_config_option("telescope_phi", "0")
-        command += super().get_config_option("camera_transmission", "1.0")
-        command += super().get_config_option("nightsky_background", "all:0.")
-        command += super().get_config_option("trigger_current_limit", "1e10")
-        command += super().get_config_option("telescope_random_angle", "0")
-        command += super().get_config_option("telescope_random_error", "0")
-        command += super().get_config_option("convergent_depth", "0")
-        command += super().get_config_option("maximum_telescopes", "1")
-        command += super().get_config_option("show", "all")
-        command += super().get_config_option("camera_filter", "none")
+        options = {
+            "random_state": "none",
+            "IMAGING_LIST": str(self._photons_file),
+            "stars": str(self._stars_file),
+            "altitude": self.site_model.get_parameter_value("corsika_observation_level"),
+            "telescope_theta": self.config.zenith_angle + self.config.off_axis_angle,
+            "star_photons": str(self.photons_per_run),
+            "telescope_phi": "0",
+            "camera_transmission": "1.0",
+            "nightsky_background": "all:0.",
+            "trigger_current_limit": "1e10",
+            "telescope_random_angle": "0",
+            "telescope_random_error": "0",
+            "convergent_depth": "0",
+            "maximum_telescopes": "1",
+            "show": "all",
+            "camera_filter": "none",
+        }
+
         if self.config.single_mirror_mode:
-            command += super().get_config_option("focus_offset", "all:0.")
-            command += super().get_config_option("camera_config_file", "single_pixel_camera.dat")
-            command += super().get_config_option("camera_pixels", "1")
-            command += super().get_config_option("trigger_pixels", "1")
-            command += super().get_config_option("camera_body_diameter", "0")
-            command += super().get_config_option(
-                "mirror_list",
-                self.telescope_model.get_single_mirror_list_file(
-                    self.config.mirror_numbers, self.config.use_random_focal_length
-                ),
-            )
-            command += super().get_config_option(
-                "focal_length", self.config.source_distance * u.km.to(u.cm)
+            options.update(
+                {
+                    "focus_offset": "all:0.",
+                    "camera_config_file": str(self._single_pixel_camera_file),
+                    "camera_pixels": "1",
+                    "trigger_pixels": "1",
+                    "camera_body_diameter": "0",
+                    "mirror_list": self.telescope_model.get_single_mirror_list_file(
+                        self.config.mirror_numbers, self.config.use_random_focal_length
+                    ),
+                    "focal_length": self.config.source_distance * u.km.to(u.cm),
+                    "dish_shape_length": _mirror_focal_length,
+                    "mirror_focal_length": _mirror_focal_length,
+                    "parabolic_dish": "0",
+                    "mirror_align_random_distance": "0.",
+                    "mirror_align_random_vertical": "0.,28.,0.,0.",
+                }
             )
-            command += super().get_config_option("dish_shape_length", _mirror_focal_length)
-            command += super().get_config_option("mirror_focal_length", _mirror_focal_length)
-            command += super().get_config_option("parabolic_dish", "0")
-            command += super().get_config_option("mirror_align_random_distance", "0.")
-            command += super().get_config_option("mirror_align_random_vertical", "0.,28.,0.,0.")
-        command += " " + str(self._corsika_file)
 
-        return clear_default_sim_telarray_cfg_directories(command), self._log_file, self._log_file
+        cmd = [
+            str(settings.config.sim_telarray_exe),
+            "-c",
+            str(config_file_path),
+            f"-I{self.telescope_model.config_file_directory}",
+        ]
+        for key, value in options.items():
+            cmd.extend(["-C", f"{key}={value}"])
+        cmd.append(str(settings.config.corsika_dummy_file))
+
+        return cmd, self._log_file, self._log_file
 
     def _check_run_result(self, run_number=None):  # pylint: disable=unused-argument
         """
@@ -223,20 +226,19 @@ class SimulatorRayTracing(SimtelRunner):
             raise RuntimeError("Photon list is empty.")
         return True
 
-    def _write_out_single_pixel_camera_file(self):
-        """Write out the single pixel camera file."""
-        with self.telescope_model.config_file_directory.joinpath("single_pixel_camera.dat").open(
-            "w"
-        ) as file:
-            file.write("# Single pixel camera\n")
-            file.write('PixType 1   0  0 300   1 300 0.00   "funnel_perfect.dat"\n')
-            file.write("Pixel 0 1 0. 0.  0  0  0 0x00 1\n")
-            file.write("Trigger 1 of 0\n")
+    def _write_out_single_pixel_camera_files(self):
+        """Write out per-label single pixel camera + funnel files.
+
+        These files are referenced by sim_telarray and must not be shared across
+        parallel worker processes (otherwise they can be truncated mid-read).
+        """
+        self._single_pixel_camera_file = (
+            self._base_directory / f"single_pixel_camera_{self.label}.dat"
+        )
+        self._funnel_file = self._base_directory / f"funnel_perfect_{self.label}.dat"
 
-        # need to also write out the funnel_perfect.dat file
-        with self.telescope_model.config_file_directory.joinpath("funnel_perfect.dat").open(
-            "w"
-        ) as file:
+        # Funnel file (referenced by absolute path from the camera file).
+        with self._funnel_file.open("w", encoding="utf-8") as file:
             file.write(
                 "# Perfect light collection where the angular efficiency of funnels is needed\n"
             )
@@ -245,6 +247,13 @@ class SimulatorRayTracing(SimtelRunner):
             file.write("60   1.0\n")
             file.write("90   1.0\n")
 
+        # Camera config.
+        with self._single_pixel_camera_file.open("w", encoding="utf-8") as file:
+            file.write("# Single pixel camera\n")
+            file.write(f'PixType 1   0  0 300   1 300 0.00   "{self._funnel_file}"\n')
+            file.write("Pixel 0 1 0. 0.  0  0  0 0x00 1\n")
+            file.write("Trigger 1 of 0\n")
+
     def _config_to_namedtuple(self, data_dict):
         """Convert dict to namedtuple for configuration."""
         config_data = namedtuple(