gammasimtools 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

simtools/simtel/simtel_config_writer.py

@@ -72,14 +72,15 @@ class SimtelConfigWriter:
 
             file.write("#ifdef TELESCOPE\n")
             file.write(
-                f"   echo Configuration for {self._telescope_model_name}"
-                " - TELESCOPE $(TELESCOPE)\n"
+                f"   echo Configuration for {self._telescope_model_name} - TELESCOPE $(TELESCOPE)\n"
             )
             file.write("#endif\n\n")
 
             for _simtel_name, value in parameters.items():
-                if _simtel_name.startswith("array_trigger"):
-                    continue  # array trigger is a site parameter, not a telescope parameter
+                # array trigger is a site parameter, not a telescope parameter
+                # fake_mirror_list is not a sim_telarray parameter (used for testeff only)
+                if _simtel_name.startswith("array_trigger") or _simtel_name == "fake_mirror_list":
+                    continue
                 if _simtel_name:
                     file.write(f"{_simtel_name} = {self._get_value_string_for_simtel(value)}\n")
             _config_meta = self._get_simtel_metadata("telescope")
@@ -294,10 +295,7 @@ class SimtelConfigWriter:
         _site_parameters = site_model.get_simtel_parameters()
         for par, value in _site_parameters.items():
             _simtel_name = names.get_simulation_software_name_from_parameter_name(
-                par,
-                simulation_software="sim_telarray",
-                search_telescope_parameters=False,
-                search_site_parameters=True,
+                par, simulation_software="sim_telarray"
             )
             _simtel_name, value = self._convert_model_parameters_to_simtel_format(
                 _simtel_name, value, model_path, telescope_model

simtools/simtel/simtel_io_histogram.py

@@ -1,8 +1,4 @@
-"""
-Reads the content of either a single histogram (.hdata) or a single simtel_array output (.simtel).
-
-Files can be zst compressed.
-"""
+"""Reads the content of either a single histogram or simtel_array output file."""
 
 import copy
 import logging
@@ -81,9 +77,9 @@ class SimtelIOHistogram:
         self._config = None
         self._total_area = None
         self._solid_angle = None
+        self._histogram = None
         self._total_num_simulated_events = None
         self._total_num_triggered_events = None
-        self._histogram = None
         self._initialize_histogram()
         self.trigger_rate = None
         self.trigger_rate_uncertainty = None
@@ -134,56 +130,39 @@ class SimtelIOHistogram:
         """
         Return information about the input parameters for the simulation.
 
+        If the file is a .hdata or .hdata.zst, config will be None.
+
         Returns
         -------
         dict:
             dictionary with information about the simulation (pyeventio MCRunHeader object).
         """
         if self._config is None:
-            # If the file is a .hdata or .hdata.zst, config will continue to be None.
             with EventIOFile(self.histogram_file) as f:
-                # Try to find configuration from .simtel file. If .hdata, config will be None
-                for obj in f:
-                    if isinstance(obj, MCRunHeader):
-                        self._config = obj.parse()
-
+                self._config = next(
+                    (obj.parse() for obj in f if isinstance(obj, MCRunHeader)), None
+                )
         return self._config
 
     @property
-    def total_num_simulated_events(self):
-        """
-        Return the total number of simulated events the histograms.
-
-        Returns
-        -------
-        int:
-            total number of simulated events.
-        """
-        if self._total_num_simulated_events is None:
-            events_histogram, _ = self.fill_event_histogram_dicts()
-            self._total_num_simulated_events = np.sum(events_histogram["data"])
-            logging.debug(f"Number of total simulated showers: {self._total_num_simulated_events}")
-        return self._total_num_simulated_events
-
-    @property
-    def total_num_triggered_events(self):
+    def total_number_of_events(self):
         """
-        Returns the total number of triggered events.
-
-        Please note that this value is not supposed to match the trigger rate x estimated
-        observation time, as the simulation is optimized for computational time and the energy
-        distribution assumed is not necessarily the reference cosmic-ray spectra.
+        Return the total number of simulated and triggered events in the histograms.
 
         Returns
         -------
-        int:
-            total number of simulated events.
+        int, int:
+            total number of simulated and triggered events.
         """
-        if self._total_num_triggered_events is None:
-            _, trigger_histogram = self.fill_event_histogram_dicts()
+        if self._total_num_simulated_events is None or self._total_num_triggered_events is None:
+            simulated_histogram, trigger_histogram = self.fill_event_histogram_dicts()
+            self._total_num_simulated_events = np.sum(simulated_histogram["data"])
             self._total_num_triggered_events = np.sum(trigger_histogram["data"])
-            logging.debug(f"Number of total triggered showers: {self._total_num_triggered_events}")
-        return self._total_num_triggered_events
+            logging.debug(
+                "Number of total simulated / triggered events: "
+                f"{self._total_num_simulated_events} / {self._total_num_triggered_events}"
+            )
+        return self._total_num_simulated_events, self._total_num_triggered_events
 
     def fill_event_histogram_dicts(self):
         """
@@ -191,34 +170,18 @@ class SimtelIOHistogram:
 
         Returns
         -------
-        dict:
-            Information about the histograms with simulated events.
-        dict:
-            Information about the histograms with triggered events.
+        tuple(dict, dict):
+            Information about the histograms with simulated and triggered events.
 
         Raises
         ------
         HistogramIdNotFoundError:
             if histogram ids not found. Problem with the file.
         """
-        # Save the appropriate histograms to variables
-        found_simulated_events_hist = False
-        found_triggered_events_hist = False
-        events_histogram = None
-        triggered_events_histogram = None
-        for hist in self.histogram:
-            if hist["id"] == 1:
-                events_histogram = hist
-                found_simulated_events_hist = True
-            elif hist["id"] == 2:
-                triggered_events_histogram = hist
-                found_triggered_events_hist = True
-            if found_simulated_events_hist * found_triggered_events_hist:
-                if "triggered_events_histogram" in locals():
-                    return events_histogram, triggered_events_histogram
-        msg = "Histograms ids not found. Please check your files."
-
-        self._logger.error(msg)
+        histograms = {hist["id"]: hist for hist in self.histogram if hist["id"] in {1, 2}}
+        if 1 in histograms and 2 in histograms:
+            return histograms[1], histograms[2]
+        self._logger.error("Histograms ids not found. Please check your files.")
         raise HistogramIdNotFoundError
 
     def _set_view_cone(self, view_cone):
@@ -456,7 +419,6 @@ class SimtelIOHistogram:
         return {
             "simtel_array_file": self.histogram_file,
             "simulation_input": self.print_info(mode="silent"),
-            # pylint: disable=E1101
             "system_trigger_rate (Hz)": self.trigger_rate.value,
         }
 
@@ -521,11 +483,11 @@ class SimtelIOHistogram:
         """
         Get the particle distribution function.
 
-        This depends  on whether one wants the reference CR distribution or the distribution
+        This depends on whether one wants the reference CR distribution or the distribution
         used in the simulation. This is controlled by label.
         By using label="reference", one gets the distribution function according to a pre-defined CR
         distribution, while by using label="simulation", the spectral index of the distribution
-        function from the simulation is used. Naturally, label="simulation" only works when the
+        function from the simulation is used. The label="simulation" works only when the
         input file is a .simtel file and not a .hdata file.
 
         Parameters
@@ -603,7 +565,8 @@ class SimtelIOHistogram:
             self.energy_range[1],
         )
         if stacked_num_simulated_events is None:
-            return (self.total_num_simulated_events / first_estimate) * u.s
+            _simulated_events, _ = self.total_number_of_events
+            return (_simulated_events / first_estimate) * u.s
         return (stacked_num_simulated_events / first_estimate) * u.s
 
     def estimate_trigger_rate_uncertainty(
@@ -648,13 +611,14 @@ class SimtelIOHistogram:
         dict:
             Dictionary with the information, e.g., view angle, energy range, etc.
         """
+        _simulated, _triggered = self.total_number_of_events
         info_dict = {
             "view_cone": self.view_cone,
             "solid_angle": self.solid_angle,
             "total_area": self.total_area,
             "energy_range": self.energy_range,
-            "total_num_simulated_events": self.total_num_simulated_events,
-            "total_num_triggered_events": self.total_num_triggered_events,
+            "total_num_simulated_events": _simulated,
+            "total_num_triggered_events": _triggered,
         }
         if mode != "silent":
             print(info_dict)

simtools/simtel/simtel_io_histograms.py

@@ -1,10 +1,4 @@
-"""
-Reads the content of multiples files from sim_telarray.
-
-Reads the content of either multiple histogram (.hdata, or .hdata.zst) or
-simtel_array output files (.simtel or .simtel.zst). The module is built on top of the
-simtel_io_histogram module and uses its class (SimtelIOHistogram) to read the individual files.
-"""
+"""Reads the content of multiples files from sim_telarray."""
 
 import copy
 import logging
@@ -192,8 +186,9 @@ class SimtelIOHistograms:
                 energy_range=self.energy_range,
                 view_cone=self.view_cone,
             )
-            stacked_num_simulated_events += simtel_hist_instance.total_num_simulated_events
-            stacked_num_triggered_events += simtel_hist_instance.total_num_triggered_events
+            _simulated, _triggered = simtel_hist_instance.total_number_of_events
+            stacked_num_simulated_events += _simulated
+            stacked_num_triggered_events += _triggered
         return stacked_num_simulated_events, stacked_num_triggered_events
 
     def _rates_for_stacked_files(self):
@@ -224,8 +219,8 @@ class SimtelIOHistograms:
         )
 
         stacked_num_simulated_events, stacked_num_triggered_events = self.get_stacked_num_events()
-        logging.info("Total number of simulated events: " f"{stacked_num_simulated_events} events")
-        logging.info("Total number of triggered events: " f"{stacked_num_triggered_events} events")
+        logging.info(f"Total number of simulated events: {stacked_num_simulated_events} events")
+        logging.info(f"Total number of triggered events: {stacked_num_triggered_events} events")
         obs_time = simtel_hist_instance.estimate_observation_time(stacked_num_simulated_events)
         logging.info(
             "Estimated equivalent observation time corresponding to the number of"
@@ -244,9 +239,7 @@ class SimtelIOHistograms:
         )
         logging.info(
             f"System trigger event rate for stacked files: "
-            # pylint: disable=E1101
-            f"{triggered_event_rate.value:.4e} \u00B1 "
-            # pylint: disable=E1101
+            f"{triggered_event_rate.value:.4e} \u00b1 "
             f"{triggered_event_rate_uncertainty.value:.4e} Hz"
         )
         return (
@@ -282,24 +275,17 @@ class SimtelIOHistograms:
             if print_info:
                 simtel_hist_instance.print_info()
 
+            _simulated_events, _triggered_events = simtel_hist_instance.total_number_of_events
             logging.info(f"Histogram {i_file + 1}:")
-            logging.info(
-                "Total number of simulated events: "
-                f"{simtel_hist_instance.total_num_simulated_events} events"
-            )
-            logging.info(
-                "Total number of triggered events: "
-                f"{simtel_hist_instance.total_num_triggered_events} events"
-            )
+            logging.info(f"Total number of simulated events: {_simulated_events} events")
+            logging.info(f"Total number of triggered events: {_triggered_events} events")
 
-            obs_time = simtel_hist_instance.estimate_observation_time(
-                simtel_hist_instance.total_num_simulated_events
-            )
+            obs_time = simtel_hist_instance.estimate_observation_time(_simulated_events)
             logging.info(
                 f"Estimated equivalent observation time corresponding to the number of "
                 f"events simulated: {obs_time.value} s"
             )
-            sim_event_rate = simtel_hist_instance.total_num_simulated_events / obs_time
+            sim_event_rate = _simulated_events / obs_time
             sim_event_rates.append(sim_event_rate)
             logging.info(f"Simulated event rate: {sim_event_rate.value:.4e} Hz")
 
@@ -310,7 +296,7 @@ class SimtelIOHistograms:
             logging.info(
                 f"System trigger event rate: "
                 # pylint: disable=E1101
-                f"{triggered_event_rate.value:.4e} \u00B1 "
+                f"{triggered_event_rate.value:.4e} \u00b1 "
                 # pylint: disable=E1101
                 f"{triggered_event_rate_uncertainty.value:.4e} Hz"
             )
@@ -515,15 +501,16 @@ class SimtelIOHistograms:
 
     def export_histograms(self, hdf5_file_name, overwrite=False):
         """
-        Export the histograms to hdf5 files.
+        Export sim_telarray histograms to hdf5 files.
 
         Parameters
         ----------
         hdf5_file_name: str
             Name of the file to be saved with the hdf5 tables.
         overwrite: bool
-            If True overwrites the histograms already saved in the hdf5 file.
+            If True overwrites histograms already saved in the hdf5 file.
         """
+        self._logger.info(f"Exporting histograms to {hdf5_file_name}.")
         for histogram in self.combined_hists:
             x_bin_edges_list = np.linspace(
                 histogram["lower_x"],
@@ -556,14 +543,10 @@ class SimtelIOHistograms:
                 f"Writing histogram with name {self._meta_dict['Title']} to {hdf5_file_name}."
             )
             # overwrite takes precedence over append
-            if overwrite is True:
-                append = False
-            else:
-                append = True
             write_table(
                 table,
                 hdf5_file_name,
                 f"/{self._meta_dict['Title']}",
-                append=append,
+                append=not overwrite,
                 overwrite=overwrite,
             )

simtools/simtel/simulator_array.py

@@ -4,6 +4,7 @@ import logging
 
 from simtools.io_operations import io_handler
 from simtools.runners.simtel_runner import InvalidOutputFileError, SimtelRunner
+from simtools.utils.general import clear_default_sim_telarray_cfg_directories
 
 __all__ = ["SimulatorArray"]
 
@@ -88,7 +89,7 @@ class SimulatorArray(SimtelRunner):
         command += f" {input_file}"
         command += f" > {self._log_file} 2>&1 || exit"
 
-        return command
+        return clear_default_sim_telarray_cfg_directories(command)
 
     def _check_run_result(self, run_number=None):
         """

simtools/simtel/simulator_camera_efficiency.py

@@ -72,9 +72,7 @@ class SimulatorCameraEfficiency(SimtelRunner):
                 / Path(self._telescope_model.get_parameter_value("nsb_reference_spectrum")).name
             )
 
-    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
         """Prepare the command used to run testeff."""
         self._logger.debug("Preparing the command to run testeff")
 
@@ -135,6 +133,8 @@ class SimulatorCameraEfficiency(SimtelRunner):
         command += f" {pixel_shape_cmd} {pixel_diameter}"
         if mirror_class == 0:
             command += f" -fmir {self._telescope_model.get_parameter_value('mirror_list')}"
+        if mirror_class == 2:
+            command += f" -fmir {self._telescope_model.get_parameter_value('fake_mirror_list')}"
         command += f" -fref {mirror_reflectivity}"
         if mirror_class == 2:
             command += " -m2"
@@ -155,6 +155,9 @@ class SimulatorCameraEfficiency(SimtelRunner):
         command += f" {self._telescope_model.get_parameter_value('atmospheric_profile')}"
         command += f" {self.zenith_angle}"
 
+        # Remove the default sim_telarray configuration directories
+        command = general.clear_default_sim_telarray_cfg_directories(command)
+
         return (
             f"cd {self._simtel_path.joinpath('sim_telarray')} && {command}",
             self._file_simtel,

simtools/simtel/simulator_light_emission.py

@@ -9,6 +9,7 @@ import numpy as np
 
 from simtools.io_operations import io_handler
 from simtools.runners.simtel_runner import SimtelRunner
+from simtools.utils.general import clear_default_sim_telarray_cfg_directories
 
 __all__ = ["SimulatorLightEmission"]
 
@@ -233,7 +234,6 @@ class SimulatorLightEmission(SimtelRunner):
         command += f"/{self.le_application[0]}"
 
         if self.light_source_type == "led":
-
             if self.le_application[1] == "variable":
                 command += f" -x {self.default_le_config['x_pos']['default'].to(u.cm).value}"
                 command += f" -y {self.default_le_config['y_pos']['default'].to(u.cm).value}"
@@ -244,7 +244,6 @@ class SimulatorLightEmission(SimtelRunner):
                 command += f" -n {self.photons_per_run}"
 
             elif self.le_application[1] == "layout":
-
                 x_origin = x_cal - x_tel
                 y_origin = y_cal - y_tel
                 z_origin = z_cal - z_tel
@@ -290,7 +289,7 @@ class SimulatorLightEmission(SimtelRunner):
 
             command += f" --telescope-theta {angle_theta}"
             command += f" --telescope-phi {angle_phi}"
-            command += f" --laser-theta {90-angles[2]}"
+            command += f" --laser-theta {90 - angles[2]}"
             command += f" --laser-phi {angles[3]}"  # convention north (x) towards east (-y)
             command += f" --atmosphere {_model_directory}/"
             command += f"{self._telescope_model.get_parameter_value('atmospheric_profile')}"
@@ -351,8 +350,7 @@ class SimulatorLightEmission(SimtelRunner):
         )
         command += super().get_config_option(
             "output_file",
-            f"{self.output_directory}/"
-            f"{self.le_application[0]}_{self.le_application[1]}.simtel.gz",
+            f"{self.output_directory}/{self.le_application[0]}_{self.le_application[1]}.simtel.gz",
         )
         command += super().get_config_option(
             "histogram_file",
@@ -360,7 +358,8 @@ class SimulatorLightEmission(SimtelRunner):
             f"{self.le_application[0]}_{self.le_application[1]}.ctsim.hdata\n",
         )
 
-        return command
+        # Remove the default sim_telarray configuration directories
+        return clear_default_sim_telarray_cfg_directories(command)
 
     def _remove_line_from_config(self, file_path, line_prefix):
         """

simtools/simtel/simulator_ray_tracing.py

@@ -8,6 +8,7 @@ import astropy.units as u
 from simtools.io_operations 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
 
 __all__ = ["SimulatorRayTracing"]
 
@@ -135,9 +136,7 @@ class SimulatorRayTracing(SimtelRunner):
             self._logger.debug("For single mirror mode, need to prepare the single pixel camera.")
             self._write_out_single_pixel_camera_file()
 
-    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 simtel_array run command."""
         if self.config.single_mirror_mode:
             # Note: no mirror length defined for dual-mirror telescopes
@@ -192,7 +191,7 @@ class SimulatorRayTracing(SimtelRunner):
             command += super().get_config_option("mirror_align_random_vertical", "0.,28.,0.,0.")
         command += " " + str(self._corsika_file)
 
-        return command, self._log_file, self._log_file
+        return clear_default_sim_telarray_cfg_directories(command), self._log_file, self._log_file
 
     def _check_run_result(self, run_number=None):  # pylint: disable=unused-argument
         """

simtools/testing/configuration.py

@@ -71,7 +71,8 @@ def _read_configs_from_files(config_files):
         _dict = gen.remove_substring_recursively_from_dict(
             gen.collect_data_from_file(file_name=config_file), substring="\n"
         )
-        configs.append(_dict.get("CTA_SIMPIPE", None))
+        for application in _dict.get("CTA_SIMPIPE", {}).get("APPLICATIONS", []):
+            configs.append(application)
     return configs
 
 

simtools/testing/helpers.py

@@ -6,19 +6,12 @@ from pathlib import Path
 
 def skip_camera_efficiency(config):
     """Skip camera efficiency tests if the old version of testeff is used."""
-    if "camera-efficiency" in config["APPLICATION"]:
-        if not _new_testeff_version():
-            return (
-                "Any applications calling the old version of testeff are skipped "
-                "due to a limitation of the old testeff not allowing to specify "
-                "the include directory. Please update your sim_telarray tarball."
-            )
-        full_test_name = f"{config['APPLICATION']}_{config['TEST_NAME']}"
-        if "simtools-validate-camera-efficiency_SSTS" == full_test_name:
-            return (
-                "The test simtools-validate-camera-efficiency_SSTS is skipped "
-                "since the fake SST mirrors are not yet implemented (#1155)"
-            )
+    if "camera-efficiency" in config["APPLICATION"] and not _new_testeff_version():
+        return (
+            "Any applications calling the old version of testeff are skipped "
+            "due to a limitation of the old testeff not allowing to specify "
+            "the include directory. Please update your sim_telarray tarball."
+        )
     return None