gammasimtools 0.5.1__py3-none-any.whl → 0.6.1__py3-none-any.whl

simtools/camera_efficiency.py

@@ -3,12 +3,11 @@ import re
 from collections import defaultdict
 
 import astropy.io.ascii
-import matplotlib.pyplot as plt
 import numpy as np
 from astropy.table import Table
 
 import simtools.utils.general as gen
-from simtools import io_handler
+from simtools.io_operations import io_handler
 from simtools.model.telescope_model import TelescopeModel
 from simtools.simtel.simtel_runner_camera_efficiency import SimtelRunnerCameraEfficiency
 from simtools.utils import names
@@ -60,20 +59,20 @@ class CameraEfficiency:
         self.io_handler = io_handler.IOHandler()
         self._base_directory = self.io_handler.get_output_directory(
             label=self.label,
-            dir_type="camera-efficiency",
-            test=test,
+            sub_dir="camera-efficiency",
+            dir_type="test" if self.test else "simtools",
         )
 
         self._results = None
         self._has_results = False
 
-        _config_data_in = gen.collect_data_from_yaml_or_dict(
+        _config_data_in = gen.collect_data_from_file_or_dict(
             config_file, config_data, allow_empty=True
         )
         _parameter_file = self.io_handler.get_input_data_file(
             "parameters", "camera-efficiency_parameters.yml"
         )
-        _parameters = gen.collect_data_from_yaml_or_dict(_parameter_file, None)
+        _parameters = gen.collect_data_from_file_or_dict(_parameter_file, None)
         self.config = gen.validate_config_data(_config_data_in, _parameters)
 
         self._load_files()
@@ -133,26 +132,29 @@ class CameraEfficiency:
         """Define the variables for the file names, including the results, simtel and log file."""
         # Results file
         file_name_results = names.camera_efficiency_results_file_name(
-            self._telescope_model.site,
-            self._telescope_model.name,
-            self.config.zenith_angle,
-            self.label,
+            site=self._telescope_model.site,
+            telescope_model_name=self._telescope_model.name,
+            zenith_angle=self.config.zenith_angle,
+            azimuth_angle=self.config.azimuth_angle,
+            label=self.label,
         )
         self._file_results = self._base_directory.joinpath(file_name_results)
         # sim_telarray output file
         file_name_simtel = names.camera_efficiency_simtel_file_name(
-            self._telescope_model.site,
-            self._telescope_model.name,
-            self.config.zenith_angle,
-            self.label,
+            site=self._telescope_model.site,
+            telescope_model_name=self._telescope_model.name,
+            zenith_angle=self.config.zenith_angle,
+            azimuth_angle=self.config.azimuth_angle,
+            label=self.label,
         )
         self._file_simtel = self._base_directory.joinpath(file_name_simtel)
         # Log file
         file_name_log = names.camera_efficiency_log_file_name(
-            self._telescope_model.site,
-            self._telescope_model.name,
-            self.config.zenith_angle,
-            self.label,
+            site=self._telescope_model.site,
+            telescope_model_name=self._telescope_model.name,
+            zenith_angle=self.config.zenith_angle,
+            azimuth_angle=self.config.azimuth_angle,
+            label=self.label,
         )
         self._file_log = self._base_directory.joinpath(file_name_log)
 
@@ -174,6 +176,7 @@ class CameraEfficiency:
             file_simtel=self._file_simtel,
             file_log=self._file_log,
             label=self.label,
+            nsb_spectrum=self.config.nsb_spectrum,
         )
         simtel.run(test=self.test, force=force)
 
@@ -262,25 +265,7 @@ class CameraEfficiency:
         self._has_results = True
 
         print("\33[40;37;1m")
-        self._logger.info(f"Spectrum weighted reflectivity: {self.calc_reflectivity():.4f}")
-        self._logger.info(
-            f"Camera nominal efficiency with gaps (B-TEL-1170): {self.calc_camera_efficiency():.4f}"
-        )
-        self._logger.info(
-            "Telescope total efficiency"
-            f" with gaps (was A-PERF-2020): {self.calc_tel_efficiency():.4f}"
-        )
-        self._logger.info(
-            (
-                "Telescope total Cherenkov light efficiency / sqrt(total NSB efficency) "
-                "(A-PERF-2025/B-TEL-0090): "
-                f"{self.calc_tot_efficiency(self.calc_tel_efficiency()):.4f}"
-            )
-        )
-        self._logger.info(
-            "Expected NSB pixel rate for the reference NSB: "
-            f"{self.calc_nsb_rate():.4f} [p.e./ns]"
-        )
+        self._logger.info(f"\n{self.results_summary()}")
         print("\033[0m")
 
         if export:
@@ -288,15 +273,54 @@ class CameraEfficiency:
 
     # END of analyze
 
+    def results_summary(self):
+        """
+        Print a summary of the results.
+        Include a header for the zenith/azimuth settings and the NSB spectrum file which was used.
+        The summary includes the various CTAO requirements and the final expected NSB pixel rate.
+        """
+        nsb_pixel_pe_per_ns, nsb_rate_ref_conditions = self.calc_nsb_rate()
+        nsb_spectrum_text = (
+            f"NSB spectrum file: {self.config.nsb_spectrum}"
+            if self.config.nsb_spectrum
+            else "default sim_telarray spectrum."
+        )
+        summary = (
+            f"Results summary for {self._telescope_model.name} at "
+            f"zenith={self.config.zenith_angle:.1f} deg, "
+            f"azimuth={self.config.azimuth_angle:.1f} deg\n"
+            f"Using the {nsb_spectrum_text}\n"
+            f"\nSpectrum weighted reflectivity: {self.calc_reflectivity():.4f}\n"
+            "Camera nominal efficiency with gaps (B-TEL-1170): "
+            f"{self.calc_camera_efficiency():.4f}\n"
+            "Telescope total efficiency"
+            f" with gaps (was A-PERF-2020): {self.calc_tel_efficiency():.4f}\n"
+            "Telescope total Cherenkov light efficiency / sqrt(total NSB efficency) "
+            "(A-PERF-2025/B-TEL-0090): "
+            f"{self.calc_tot_efficiency(self.calc_tel_efficiency()):.4f}\n"
+            "Expected NSB pixel rate for the provided NSB spectrum: "
+            f"{nsb_pixel_pe_per_ns:.4f} [p.e./ns]\n"
+            "Expected NSB pixel rate for the reference NSB: "
+            f"{nsb_rate_ref_conditions:.4f} [p.e./ns]\n"
+        )
+
+        return summary
+
     def export_results(self):
-        """Export results to a csv file."""
+        """Export results to a ecsv file."""
         if not self._has_results:
             self._logger.error("Cannot export results because they do not exist")
         else:
-            self._logger.info(f"Exporting results to {self._file_results}")
+            self._logger.info(f"Exporting testeff table to {self._file_results}")
             astropy.io.ascii.write(
                 self._results, self._file_results, format="basic", overwrite=True
             )
+            _results_summary_file = (
+                str(self._file_results).replace(".ecsv", ".txt").replace("-table-", "-summary-")
+            )
+            self._logger.info(f"Exporting summary results to {_results_summary_file}")
+            with open(_results_summary_file, "w", encoding="utf-8") as file:
+                file.write(self.results_summary())
 
     def _read_results(self):
         """Read existing results file and store it in _results."""
@@ -404,21 +428,21 @@ class CameraEfficiency:
 
         Returns
         -------
-        nsb_rate
-            NSB rate in p.e./ns
+        nsb_rate_provided_spectrum: float
+            NSB pixel rate in p.e./ns for the provided NSB spectrum
+        nsb_rate_ref_conditions: float
+            NSB pixel rate in p.e./ns for reference conditions
+            (https://jama.cta-observatory.org/perspective.req#/items/26694?projectId=11)
         """
 
-        nsb_pe_per_ns = (
+        nsb_rate_provided_spectrum = (
             np.sum(self._results["N4"])
             * self._telescope_model.camera.get_pixel_active_solid_angle()
             * self._telescope_model.get_on_axis_eff_optical_area().to("m2").value
             / self._telescope_model.get_telescope_transmission_parameters()[0]
         )
 
-        print(self._telescope_model.get_on_axis_eff_optical_area().to("m2").value)
-
-        # NSB input spectrum is from Benn&Ellison
-        # (integral is in ph./(cm² ns sr) ) from 300 - 650 nm:
+        # (integral is in ph./(m^2 ns sr) ) from 300 - 650 nm:
         n1_reduced_wl = self._results["N1"][[299 < wl_now < 651 for wl_now in self._results["wl"]]]
         n1_sum = np.sum(n1_reduced_wl)
         n1_integral_edges = self._results["N1"][
@@ -426,43 +450,12 @@ class CameraEfficiency:
         ]
         n1_integral_edges_sum = np.sum(n1_integral_edges)
         nsb_integral = 0.0001 * (n1_sum - 0.5 * n1_integral_edges_sum)
-        nsb_rate = (
-            nsb_pe_per_ns
+        nsb_rate_ref_conditions = (
+            nsb_rate_provided_spectrum
             * self._telescope_model.reference_data["nsb_reference_value"]["Value"]
             / nsb_integral
         )
-        return nsb_rate
-
-    def plot(self, key, **kwargs):  # FIXME - remove this function, probably not needed
-        """
-        Plot key vs wavelength.
-
-        Parameters
-        ----------
-        key: str
-            cherenkov or nsb
-        **kwargs:
-            kwargs for plt.plot
-
-        Raises
-        ------
-        KeyError
-            If key is not among the valid options.
-        """
-        if key not in ["cherenkov", "nsb"]:
-            msg = "Invalid key to plot"
-            self._logger.error(msg)
-            raise KeyError(msg)
-
-        ax = plt.gca()
-        first_letter = "C" if key == "cherenkov" else "N"
-        for par in ["1", "2", "3", "4", "4x"]:
-            ax.plot(
-                self._results["wl"],
-                self._results[first_letter + par],
-                label=first_letter + par,
-                **kwargs,
-            )
+        return nsb_rate_provided_spectrum, nsb_rate_ref_conditions
 
     def plot_cherenkov_efficiency(self):
         """

simtools/configuration/commandline_parser.py

@@ -32,6 +32,7 @@ class CommandLineParser(argparse.ArgumentParser):
         paths=True,
         output=False,
         telescope_model=False,
+        site_model=False,
         db_config=False,
         job_submission=False,
     ):
@@ -46,6 +47,8 @@ class CommandLineParser(argparse.ArgumentParser):
             Add output file configuration to list of args.
         telescope_model: bool
             Add telescope model configuration to list of args.
+        site_model: bool
+            Add site model configuration to list of args (not required of telescope_model is True).
         db_config: bool
             Add database configuration parameters to list of args.
         job_submission: bool
@@ -54,6 +57,8 @@ class CommandLineParser(argparse.ArgumentParser):
 
         if telescope_model:
             self.initialize_telescope_model_arguments()
+        elif site_model:
+            self.initialize_telescope_model_arguments(add_telescope=False)
         if job_submission:
             self.initialize_job_submission_arguments()
         if db_config:
@@ -79,6 +84,13 @@ class CommandLineParser(argparse.ArgumentParser):
             type=str,
             required=False,
         )
+        _job_group.add_argument(
+            "--env_file",
+            help="file with environment variables",
+            default=".env",
+            type=str,
+            required=False,
+        )
 
     def initialize_path_arguments(self):
         """
@@ -96,12 +108,12 @@ class CommandLineParser(argparse.ArgumentParser):
             "--output_path",
             help="path pointing towards output directory",
             type=Path,
-            default=".",
+            default="./simtools-output/",
             required=False,
         )
         _job_group.add_argument(
             "--use_plain_output_path",
-            help="use plain output path (without adding the tool name and dates)",
+            help="use plain output path (without the tool name and dates)",
             action="store_true",
             required=False,
         )
@@ -138,6 +150,13 @@ class CommandLineParser(argparse.ArgumentParser):
             default="ecsv",
             required=False,
         )
+        _job_group.add_argument(
+            "--skip_output_validation",
+            help="skip output data validation against schema",
+            default=False,
+            required=False,
+            action="store_true",
+        )
 
     def initialize_application_execution_arguments(self):
         """
@@ -160,7 +179,7 @@ class CommandLineParser(argparse.ArgumentParser):
             "--log_level",
             action="store",
             default="info",
-            help="log level to print (default is INFO)",
+            help="log level to print",
             required=False,
         )
         _job_group.add_argument(
@@ -181,7 +200,7 @@ class CommandLineParser(argparse.ArgumentParser):
         )
         _job_group.add_argument(
             "--db_api_authentication_database",
-            help="database  with user info (optional, default is 'admin')",
+            help="database  with user info (optional)",
             type=str,
             required=False,
             default="admin",
@@ -223,7 +242,10 @@ class CommandLineParser(argparse.ArgumentParser):
             Set to allow a telescope name argument.
         """
 
-        _job_group = self.add_argument_group("telescope model")
+        if add_telescope:
+            _job_group = self.add_argument_group("telescope model")
+        else:
+            _job_group = self.add_argument_group("site model")
         _job_group.add_argument(
             "--site", help="CTAO site (e.g., North, South)", type=self.site, required=False
         )
@@ -238,7 +260,7 @@ class CommandLineParser(argparse.ArgumentParser):
                 "--model_version",
                 help="model version",
                 type=str,
-                default="Current",
+                default="Released",
             )
 
     @staticmethod
@@ -263,10 +285,8 @@ class CommandLineParser(argparse.ArgumentParser):
 
         """
 
-        fsite = str(value)
-        if not names.validate_site_name(fsite):
-            raise argparse.ArgumentTypeError(f"{fsite} is an invalid site")
-        return fsite
+        names.validate_site_name(str(value))
+        return str(value)
 
     @staticmethod
     def telescope(value):
@@ -290,10 +310,8 @@ class CommandLineParser(argparse.ArgumentParser):
 
         """
 
-        ftelescope = str(value)
-        if not names.validate_telescope_model_name(ftelescope):
-            raise argparse.ArgumentTypeError(f"{ftelescope} is an invalid telescope name")
-        return ftelescope
+        names.validate_telescope_model_name(str(value))
+        return str(value)
 
     @staticmethod
     def efficiency_interval(value):
@@ -334,7 +352,7 @@ class CommandLineParser(argparse.ArgumentParser):
 
         Parameters
         ----------
-        angle: float
+        angle: float, str, astropy.Quantity
             zenith angle to verify
 
         Returns
@@ -353,17 +371,22 @@ class CommandLineParser(argparse.ArgumentParser):
         logger = logging.getLogger(__name__)
 
         try:
-            fangle = float(angle)
-        except ValueError:
-            logger.error("The zenith angle provided is not a valid numeric value.")
-            raise
-        if fangle < 0.0 or fangle > 180.0:
+            try:
+                fangle = float(angle) * u.deg
+            except ValueError:
+                fangle = u.Quantity(angle).to("deg")
+        except TypeError as exc:
+            logger.error(
+                "The zenith angle provided is not a valid numerical or astropy.Quantity value."
+            )
+            raise exc
+        if fangle < 0.0 * u.deg or fangle > 180.0 * u.deg:
             raise argparse.ArgumentTypeError(
                 f"The provided zenith angle, {angle:.1f}, "
                 "is outside of the allowed [0, 180] interval"
             )
 
-        return fangle * u.deg
+        return fangle
 
     @staticmethod
     def azimuth_angle(angle):
@@ -380,7 +403,7 @@ class CommandLineParser(argparse.ArgumentParser):
         Returns
         -------
         Astropy.Quantity
-            Validated/Converted aziumth angle in degrees
+            Validated/Converted azimuth angle in degrees
 
         Raises
         ------
@@ -403,6 +426,13 @@ class CommandLineParser(argparse.ArgumentParser):
         except ValueError:
             logger.debug(
                 "The azimuth angle provided is not a valid numeric value. "
+                "Will check if it is an astropy.Quantity instead"
+            )
+        try:
+            return u.Quantity(angle).to("deg")
+        except TypeError:
+            logger.debug(
+                "The azimuth angle provided is not a valid astropy.Quantity. "
                 "Will check if it is (north, south, east, west) instead"
             )
         if isinstance(angle, str):