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

simtools/reporting/docs_read_parameters.py

@@ -17,7 +17,7 @@ from simtools.io import ascii_handler, io_handler
 from simtools.model.telescope_model import TelescopeModel
 from simtools.utils import names
 from simtools.version import sort_versions
-from simtools.visualization import plot_pixels, plot_tables
+from simtools.visualization import plot_mirrors, plot_pixels, plot_tables
 
 logger = logging.getLogger()
 MARKDOWN_LINK_RE = re.compile(r"\[([^\]]+)\]\(([^)]+)\)")
@@ -72,6 +72,12 @@ class ReadParameters:
 
         if parameter == "camera_config_file":
             plot_names = self._plot_camera_config(parameter, parameter_version, input_file, outpath)
+        elif parameter in (
+            "mirror_list",
+            "primary_mirror_segmentation",
+            "secondary_mirror_segmentation",
+        ):
+            plot_names = self._plot_mirror_config(parameter, parameter_version, input_file, outpath)
         elif parameter_version:
             plot_names = self._plot_parameter_tables(
                 parameter,
@@ -115,6 +121,39 @@ class ReadParameters:
 
         return plot_names
 
+    def _plot_mirror_config(self, parameter, parameter_version, input_file, outpath):
+        """Generate plots for mirror configuration files."""
+        if not parameter_version:
+            return []
+
+        plot_names = []
+        plot_name = input_file.stem.replace(".", "-")
+        plot_path = Path(f"{outpath}/{plot_name}").with_suffix(".png")
+
+        if not plot_path.exists():
+            plot_config = {
+                "parameter": parameter,
+                "telescope": self.array_element,
+                "parameter_version": parameter_version,
+                "site": self.site,
+                "model_version": self.model_version,
+            }
+
+            plot_mirrors.plot(
+                config=plot_config,
+                output_file=Path(f"{outpath}/{plot_name}"),
+                db_config=self.db_config,
+            )
+            plot_names.append(plot_name)
+        else:
+            logger.info(
+                "Mirror configuration file plot already exists: %s",
+                plot_path,
+            )
+            plot_names.append(plot_name)
+
+        return plot_names
+
     def _plot_parameter_tables(self, parameter, parameter_version, outpath):
         """Generate plots for parameter tables."""
         tel = self._get_telescope_identifier()
@@ -175,7 +214,7 @@ class ReadParameters:
         markdown_output_file = output_data_path / output_file_name
 
         if not markdown_output_file.exists():
-            outpath = Path(io_handler.IOHandler().get_output_directory().parent / "_images")
+            outpath = io_handler.IOHandler().get_output_directory("_images")
             outpath.mkdir(parents=True, exist_ok=True)
 
             plot_names = self._generate_plots(parameter, parameter_version, input_file, outpath)
@@ -648,7 +687,7 @@ class ReadParameters:
 
     def _write_file_flag_section(self, file, parameter, comparison_data):
         """Write image/plot references when parameter entries include files."""
-        outpath = Path(io_handler.IOHandler().get_output_directory().parent / "_images")
+        outpath = io_handler.IOHandler().get_output_directory("_images")
         latest_parameter_version = max(
             comparison_data.get(parameter),
             key=lambda x: tuple(map(int, x["parameter_version"].split("."))),
@@ -664,13 +703,25 @@ class ReadParameters:
 
         file.write("The latest parameter version is plotted below.\n\n")
 
-        if parameter != "camera_config_file":
-            plot_name = f"{parameter}_{latest_parameter_version}_{self.site}_{tel}"
-            image_path = outpath / f"{plot_name}.png"
-            file.write(f"![Parameter plot.]({image_path.as_posix()})")
+        if parameter in (
+            "camera_config_file",
+            "mirror_list",
+            "primary_mirror_segmentation",
+            "secondary_mirror_segmentation",
+        ):
+            self._write_file_based_plot(
+                file, parameter, comparison_data, latest_model_version, outpath
+            )
             return
 
-        # camera_config_file: find latest value and convert markdown link to png filename
+        plot_name = f"{parameter}_{latest_parameter_version}_{self.site}_{tel}"
+        image_path = outpath / f"{plot_name}.png"
+        file.write(f"![Parameter plot.]({image_path.as_posix()})")
+
+    def _write_file_based_plot(
+        self, file, parameter, comparison_data, latest_model_version, outpath
+    ):
+        """Write plot reference for file-based parameters."""
         latest_value = None
         for item in comparison_data.get(parameter):
             if latest_model_version in item["model_version"].split(", "):
@@ -686,7 +737,16 @@ class ReadParameters:
 
         filename_png = Path(match.group(1)).with_suffix(".png").name
         image_path = outpath / filename_png
-        file.write(f"![Camera configuration plot.]({image_path.as_posix()})")
+
+        plot_descriptions = {
+            "camera_config_file": "Camera configuration plot",
+            "mirror_list": "Mirror panel layout",
+            "primary_mirror_segmentation": "Primary mirror segmentation",
+            "secondary_mirror_segmentation": "Secondary mirror segmentation",
+        }
+
+        description = plot_descriptions.get(parameter, "Parameter plot")
+        file.write(f"![{description}.]({image_path.as_posix()})")
 
     def _write_array_layouts_section(self, file, layouts):
         """Write the array layouts section of the report."""

simtools/runners/corsika_runner.py

@@ -34,6 +34,8 @@ class CorsikaRunner:
         Use seeds based on run number and primary particle. If False, use sim_telarray seeds.
     use_multipipe: bool
         Use multipipe to run CORSIKA and sim_telarray.
+    curved_atmosphere_min_zenith_angle: Quantity
+        Minimum zenith angle for which to use the curved-atmosphere CORSIKA binary.
     """
 
     def __init__(
@@ -43,6 +45,7 @@ class CorsikaRunner:
         label=None,
         keep_seeds=False,
         use_multipipe=False,
+        curved_atmosphere_min_zenith_angle=None,
     ):
         """Initialize CorsikaRunner."""
         self._logger = logging.getLogger(__name__)
@@ -52,6 +55,7 @@ class CorsikaRunner:
         self.corsika_config = corsika_config
         self._keep_seeds = keep_seeds
         self._use_multipipe = use_multipipe
+        self.curved_atmosphere_min_zenith_angle = curved_atmosphere_min_zenith_angle
 
         self._simtel_path = Path(simtel_path)
         self.io_handler = io_handler.IOHandler()
@@ -63,7 +67,7 @@ class CorsikaRunner:
         self, run_number=None, extra_commands=None, input_file=None, use_pfp=True
     ):
         """
-        Get the full path of the run script file for a given run number.
+        Prepare and write CORSIKA run script.
 
         Parameters
         ----------
@@ -183,7 +187,7 @@ class CorsikaRunner:
         """
         Get autoinputs command.
 
-        corsika_autoinputs is a tool to generate random and user/host dependent
+        corsika_autoinputs is a tool to generate random seeds and user/host dependent
         parameters for CORSIKA configuration.
 
         Parameters
@@ -198,7 +202,12 @@ class CorsikaRunner:
         str
             autoinputs command.
         """
-        corsika_bin_path = self._simtel_path.joinpath("corsika-run/corsika")
+        if self.corsika_config.use_curved_atmosphere:
+            corsika_bin_path = self._simtel_path.joinpath("corsika-run/corsika-curved")
+            self._logger.debug("Using curved-atmosphere CORSIKA binary.")
+        else:
+            corsika_bin_path = self._simtel_path.joinpath("corsika-run/corsika")
+            self._logger.debug("Using flat-atmosphere CORSIKA binary.")
 
         log_file = self.get_file_name(file_type="log", run_number=run_number)
         if self._use_multipipe:

simtools/runners/corsika_simtel_runner.py

@@ -45,6 +45,7 @@ class CorsikaSimtelRunner:
         sim_telarray_seeds=None,
         sequential=False,
         calibration_config=None,
+        curved_atmosphere_min_zenith_angle=None,
     ):
         self._logger = logging.getLogger(__name__)
         self.corsika_config = gen.ensure_iterable(corsika_config)
@@ -63,6 +64,7 @@ class CorsikaSimtelRunner:
             label=label,
             keep_seeds=keep_seeds,
             use_multipipe=use_multipipe,
+            curved_atmosphere_min_zenith_angle=curved_atmosphere_min_zenith_angle,
         )
         # The simulator array should be defined for every CORSIKA configuration
         # because it allows to define multiple sim_telarray instances
@@ -218,3 +220,7 @@ class CorsikaSimtelRunner:
             else self.simulator_array[model_version_index]
         )
         return runner.get_file_name(file_type=file_type, run_number=run_number, mode=mode)
+
+    def get_resources(self, run_number=None):
+        """Return computing resources used."""
+        return self.corsika_runner.get_resources(run_number)

simtools/runners/runner_services.py

@@ -28,7 +28,7 @@ class RunnerServices:
         self.corsika_config = corsika_config
         self.directory = {}
 
-    def _get_info_for_file_name(self, run_number):
+    def _get_info_for_file_name(self, run_number, calibration_run_mode=None):
         """
         Return dictionary for building names for simulation output files.
 
@@ -36,6 +36,8 @@ class RunnerServices:
         ----------
         run_number : int
             Run number.
+        calibration_run_mode: str
+            Calibration run mode.
 
         Returns
         -------
@@ -43,9 +45,12 @@ class RunnerServices:
             Dictionary with the keys or building the file names for simulation output files.
         """
         _vc_high = self.corsika_config.get_config_parameter("VIEWCONE")[1]
-        primary_name = self.corsika_config.primary
-        if primary_name == "gamma" and _vc_high > 0:
-            primary_name = "gamma_diffuse"
+        if calibration_run_mode is not None and calibration_run_mode != "":
+            primary_name = calibration_run_mode
+        else:
+            primary_name = self.corsika_config.primary
+            if primary_name == "gamma" and _vc_high > 0:
+                primary_name = "gamma_diffuse"
         return {
             "run_number": self.corsika_config.validate_run_number(run_number),
             "primary": primary_name,
@@ -119,7 +124,7 @@ class RunnerServices:
         _logger.debug(f"Checking if {run_sub_file} exists")
         return Path(run_sub_file).is_file()
 
-    def _get_file_basename(self, run_number):
+    def _get_file_basename(self, run_number, calibration_run_mode):
         """
         Get the base name for the simulation files.
 
@@ -127,13 +132,15 @@ class RunnerServices:
         ----------
         run_number: int
             Run number.
+        calibration_run_mode: str
+            Calibration run mode.
 
         Returns
         -------
         str
             Base name for the simulation files.
         """
-        info_for_file_name = self._get_info_for_file_name(run_number)
+        info_for_file_name = self._get_info_for_file_name(run_number, calibration_run_mode)
         file_label = f"_{info_for_file_name['label']}" if info_for_file_name.get("label") else ""
         zenith = self.corsika_config.get_config_parameter("THETAP")[0]
         azimuth = self.corsika_config.azimuth_angle
@@ -232,6 +239,7 @@ class RunnerServices:
         file_type,
         run_number=None,
         mode=None,
+        calibration_run_mode=None,
         _model_version_index=0,
     ):  # pylint: disable=unused-argument
         """
@@ -245,6 +253,8 @@ class RunnerServices:
             Run number.
         mode: str
             out or err (optional, relevant only for sub_log).
+        calibration_run_mode: str
+            Calibration run mode.
         model_version_index: int
             Index of the model version.
             This is not used here, but in other implementations of this function is
@@ -261,7 +271,7 @@ class RunnerServices:
         ValueError
             If file_type is unknown.
         """
-        file_name = self._get_file_basename(run_number)
+        file_name = self._get_file_basename(run_number, calibration_run_mode)
 
         if file_type in ["log", "histogram", "corsika_log"]:
             return self._get_log_file_path(file_type, file_name)

simtools/runners/simtel_runner.py

@@ -1,7 +1,6 @@
 """Base class for running sim_telarray simulations."""
 
 import logging
-import stat
 import subprocess
 from pathlib import Path
 
@@ -34,15 +33,25 @@ class SimtelRunner:
         CORSIKA configuration.
     use_multipipe: bool
         Use multipipe to run CORSIKA and sim_telarray.
+    calibration_run_mode: str
+        Calibration run mode.
     """
 
-    def __init__(self, simtel_path, label=None, corsika_config=None, use_multipipe=False):
+    def __init__(
+        self,
+        simtel_path,
+        label=None,
+        corsika_config=None,
+        use_multipipe=False,
+        calibration_run_mode=None,
+    ):
         """Initialize SimtelRunner."""
         self._logger = logging.getLogger(__name__)
 
         self._simtel_path = Path(simtel_path)
         self.label = label
         self._base_directory = None
+        self.calibration_run_mode = calibration_run_mode
 
         self.runs_per_set = 1
 
@@ -51,56 +60,6 @@ class SimtelRunner:
             "corsika_sim_telarray" if use_multipipe else "sim_telarray"
         )
 
-    def __repr__(self):
-        """Return a string representation of the SimtelRunner object."""
-        return f"SimtelRunner(label={self.label})\n"
-
-    def prepare_run_script(self, test=False, input_file=None, run_number=None, extra_commands=None):
-        """
-        Build and return the full path of the bash run script containing the sim_telarray command.
-
-        Parameters
-        ----------
-        test: bool
-            Test flag for faster execution.
-        input_file: str or Path
-            Full path of the input CORSIKA file.
-        run_number: int
-            Run number.
-        extra_commands: str
-            Additional commands for running simulations given in config.yml.
-
-        Returns
-        -------
-        Path
-            Full path of the run script.
-        """
-        script_file_path = self.get_file_name(file_type="sub_script", run_number=run_number)
-        self._logger.debug(f"Run bash script - {script_file_path}")
-        self._logger.debug(f"Extra commands to be added to the run script {extra_commands}")
-
-        command = self._make_run_command(run_number=run_number, input_file=input_file)
-        with script_file_path.open("w", encoding="utf-8") as file:
-            file.write("#!/usr/bin/env bash\n\n")
-            file.write("set -e\n")
-            file.write("set -o pipefail\n")
-            file.write("\nSECONDS=0\n")
-
-            if extra_commands is not None:
-                file.write("# Writing extras\n")
-                for line in extra_commands:
-                    file.write(f"{line}\n")
-                file.write("# End of extras\n\n")
-
-            n = 1 if test else self.runs_per_set
-            for _ in range(n):
-                file.write(f"{command}\n\n")
-
-            file.write('\necho "RUNTIME: $SECONDS"\n')
-
-        script_file_path.chmod(script_file_path.stat().st_mode | stat.S_IXUSR | stat.S_IXGRP)
-        return script_file_path
-
     def run(self, test=False, input_file=None, run_number=None):
         """
         Make run command and run sim_telarray.
@@ -148,8 +107,6 @@ class SimtelRunner:
             msg = gen.get_log_excerpt(self._log_file)
         else:
             msg = "Simtel log file does not exist."
-
-        self._logger.error(msg)
         raise SimtelExecutionError(msg)
 
     def _run_simtel_and_check_output(self, command, stdout_file, stderr_file):
@@ -255,4 +212,5 @@ class SimtelRunner:
             run_number=run_number,
             mode=mode,
             _model_version_index=model_version_index,
+            calibration_run_mode=self.calibration_run_mode,
         )

simtools/schemas/model_parameters/flasher_pulse_exp_decay.schema.yml

@@ -1,6 +1,8 @@
 %YAML 1.2
 ---
 title: Schema for flasher_pulse_exp_decay model parameter
+deprecated: true
+deprecation_note: "Replaced by updated definition of flasher_pulse_shape"
 schema_version: 0.1.0
 meta_schema: simpipe-schema
 meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml

simtools/schemas/model_parameters/flasher_pulse_shape.schema.yml

@@ -1,6 +1,56 @@
 %YAML 1.2
 ---
 title: Schema for flasher_pulse_shape model parameter
+schema_version: 0.2.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: flasher_pulse_shape
+short_description: |-
+  Definition of flasher pulse shape.
+description: |-
+  Definition of flasher pulse shape both shape and relevant
+  timing parameters.
+data:
+  - type: string
+    description: Shape of the flasher pulse.
+    default: Gauss
+    allowed_values:
+      - Gauss
+      - TopHat
+      - Exponential
+      - Gauss-Exponential
+  - type: float64
+    description: |-
+     Characteristic width of the flasher pulse shape.
+     For 'TopHat', this is the pulse width, for 'Gauss' and 'Gauss-Exponential'
+     the rms width. Ignored if shape is 'Exponential'.
+    unit: ns
+    default: 0
+    allowed_range:
+      min: 0
+  - type: float64
+    description: |-
+      Exponential decay time of the flasher pulse shape.
+      Only relevant if shape is 'Exponential' or 'Gauss-Exponential'.
+    unit: ns
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: simtools
+    version: ">0.24.0"
+---
+title: Schema for flasher_pulse_shape model parameter
 schema_version: 0.1.0
 meta_schema: simpipe-schema
 meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml

simtools/schemas/model_parameters/flasher_pulse_width.schema.yml

@@ -1,6 +1,8 @@
 %YAML 1.2
 ---
 title: Schema for flasher_pulse_width model parameter
+deprecated: true
+deprecation_note: "Replaced by updated definition of flasher_pulse_shape"
 schema_version: 0.1.0
 meta_schema: simpipe-schema
 meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml

simtools/schemas/simulation_models_info.schema.yml

@@ -74,6 +74,8 @@ $defs:
           - type: string
           - type: array
           - type: "null"
+      model_parameter_schema_version:
+        $ref: 'common_definitions.schema.yml#/$defs/semantic_version_pattern'
     required:
       - version
     additionalProperties: false