gammasimtools 0.15.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

simtools/runners/corsika_simtel_runner.py

@@ -6,7 +6,6 @@ from pathlib import Path
 
 from simtools.runners.corsika_runner import CorsikaRunner
 from simtools.simtel.simulator_array import SimulatorArray
-from simtools.utils.general import clear_default_sim_telarray_cfg_directories
 
 __all__ = ["CorsikaSimtelRunner"]
 
@@ -20,8 +19,9 @@ class CorsikaSimtelRunner:
 
     Parameters
     ----------
-    corsika_config : CorsikaConfig
-        Configuration parameters for CORSIKA.
+    corsika_config : CorsikaConfig or list of CorsikaConfig
+        A list of "CorsikaConfig" instances which
+        contain the CORSIKA configuration parameters.
     simtel_path : str or Path
         Location of the sim_telarray package.
     label : str
@@ -30,6 +30,8 @@ class CorsikaSimtelRunner:
         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.
+    sim_telarray_seeds : dict
+        Dictionary with configuration for sim_telarray random instrument setup.
     """
 
     def __init__(
@@ -42,26 +44,37 @@ class CorsikaSimtelRunner:
         sim_telarray_seeds=None,
     ):
         self._logger = logging.getLogger(__name__)
-        self.corsika_config = corsika_config
+        self.corsika_config = (
+            corsika_config if isinstance(corsika_config, list) else [corsika_config]
+        )
+        # the base corsika config is the one used to define the CORSIKA specific parameters.
+        # The others are used for the array configurations.
+        self.base_corsika_config = self.corsika_config[0]
         self._simtel_path = simtel_path
         self.sim_telarray_seeds = sim_telarray_seeds
         self.label = label
 
-        self.corsika_config.set_output_file_and_directory(use_multipipe)
+        self.base_corsika_config.set_output_file_and_directory(use_multipipe)
         self.corsika_runner = CorsikaRunner(
-            corsika_config=corsika_config,
+            corsika_config=self.base_corsika_config,
             simtel_path=simtel_path,
             label=label,
             keep_seeds=keep_seeds,
             use_multipipe=use_multipipe,
         )
-        self.simulator_array = SimulatorArray(
-            corsika_config=corsika_config,
-            simtel_path=simtel_path,
-            label=label,
-            use_multipipe=use_multipipe,
-            sim_telarray_seeds=sim_telarray_seeds,
-        )
+        # The simulator array should be defined for every CORSIKA configuration
+        # because it allows to define multiple sim_telarray instances
+        self.simulator_array = []
+        for _corsika_config in self.corsika_config:
+            self.simulator_array.append(
+                SimulatorArray(
+                    corsika_config=_corsika_config,
+                    simtel_path=simtel_path,
+                    label=label,
+                    use_multipipe=use_multipipe,
+                    sim_telarray_seeds=sim_telarray_seeds,
+                )
+            )
 
     def prepare_run_script(
         self, run_number=None, input_file=None, extra_commands=None, use_pfp=False
@@ -103,18 +116,43 @@ class CorsikaSimtelRunner:
         Path:
             Full path of the run script file.
         """
-        run_command = self._make_run_command(
-            run_number=run_number,
-            input_file="-",  # instruct sim_telarray to take input from standard output
-        )
-        multipipe_file = Path(self.corsika_config.config_file_path.parent).joinpath(
-            self.corsika_config.get_corsika_config_file_name("multipipe")
+        multipipe_file = Path(self.base_corsika_config.config_file_path.parent).joinpath(
+            self.base_corsika_config.get_corsika_config_file_name("multipipe")
         )
+
         with open(multipipe_file, "w", encoding="utf-8") as file:
-            file.write(f"{run_command}")
+            for simulator_array in self.simulator_array:
+                run_command = simulator_array.make_run_command(
+                    run_number=run_number,
+                    input_file="-",  # instruct sim_telarray to take input from standard output
+                    weak_pointing=self._determine_pointing_option(self.label),
+                )
+                file.write(f"{run_command}")
+                file.write("\n")
         self._logger.info(f"Multipipe script: {multipipe_file}")
         self._write_multipipe_script(multipipe_file)
 
+    @staticmethod
+    def _determine_pointing_option(label):
+        """
+        Determine the pointing option for sim_telarray.
+
+        Parameters
+        ----------
+        label: str
+            Label of the simulation.
+
+        Returns
+        -------
+        str:
+            Pointing option.
+        """
+        try:
+            return any(pointing in label for pointing in ["divergent", "convergent"])
+        except TypeError:  # allow for pointing_option to be None
+            pass
+        return False
+
     def _write_multipipe_script(self, multipipe_file):
         """
         Write script used to call the multipipe_corsika command.
@@ -124,7 +162,7 @@ class CorsikaSimtelRunner:
         multipipe_file: str or Path
             The name of the multipipe file which contains all of the multipipe commands.
         """
-        multipipe_script = Path(self.corsika_config.config_file_path.parent).joinpath(
+        multipipe_script = Path(self.base_corsika_config.config_file_path.parent).joinpath(
             "run_cta_multipipe"
         )
         with open(multipipe_script, "w", encoding="utf-8") as file:
@@ -135,71 +173,14 @@ class CorsikaSimtelRunner:
 
         multipipe_script.chmod(multipipe_script.stat().st_mode | stat.S_IEXEC)
 
-    def _make_run_command(self, run_number=None, input_file=None):
-        """
-        Build and return the command to run simtel_array.
-
-        Parameters
-        ----------
-        run_number: int
-            Run number.
-        input_file: str
-            Full path of the input CORSIKA file.
-            Use '-' to tell sim_telarray to read from standard output
-
-        Returns
-        -------
-        str:
-            Command to run sim_telarray.
-        """
-        try:
-            weak_pointing = any(pointing in self.label for pointing in ["divergent", "convergent"])
-        except TypeError:  # allow for self.label to be None
-            weak_pointing = False
-
-        command = str(self._simtel_path.joinpath("sim_telarray/bin/sim_telarray"))
-        command += f" -c {self.corsika_config.array_model.get_config_file()}"
-        command += f" -I{self.corsika_config.array_model.get_config_directory()}"
-        command += self.simulator_array.get_config_option(
-            "telescope_theta", self.corsika_config.zenith_angle, weak_option=weak_pointing
-        )
-        command += self.simulator_array.get_config_option(
-            "telescope_phi", self.corsika_config.azimuth_angle, weak_option=weak_pointing
-        )
-        command += self.simulator_array.get_config_option(
-            "power_law",
-            SimulatorArray.get_power_law_for_sim_telarray_histograms(
-                self.corsika_config.primary_particle
-            ),
-        )
-        command += self.simulator_array.get_config_option(
-            "histogram_file",
-            self.get_file_name(
-                simulation_software="simtel", file_type="histogram", run_number=run_number
-            ),
-        )
-        command += self.simulator_array.get_config_option("random_state", "none")
-        if self.sim_telarray_seeds:
-            command += self.simulator_array.get_config_option(
-                "random_seed", self.sim_telarray_seeds
-            )
-        command += self.simulator_array.get_config_option("show", "all")
-        command += self.simulator_array.get_config_option(
-            "output_file",
-            self.simulator_array.get_file_name(
-                simulation_software="simtel", file_type="output", run_number=run_number
-            ),
-        )
-        command += f" {input_file}"
-        _log_file = self.simulator_array.get_file_name(
-            simulation_software="simtel", file_type="log", run_number=run_number
-        )
-        command += f" | gzip > {_log_file} 2>&1 || exit"
-
-        # Remove the default sim_telarray configuration directories
-        return clear_default_sim_telarray_cfg_directories(command)
-
-    def get_file_name(self, simulation_software=None, file_type=None, run_number=None, mode=None):
+    def get_file_name(
+        self,
+        simulation_software=None,
+        file_type=None,
+        run_number=None,
+        mode=None,
+        model_version_index=0,
+    ):
         """
         Get the full path of a file for a given run number.
 
@@ -211,6 +192,12 @@ class CorsikaSimtelRunner:
             File type.
         run_number: int
             Run number.
+        mode: str
+            Mode to use for the file name.
+        model_version_index: int
+            Index of the model version.
+            This is used to select the correct simulator_array instance
+            in case multiple array models are simulated.
 
         Returns
         -------
@@ -218,8 +205,12 @@ class CorsikaSimtelRunner:
             File name with full path.
         """
         if simulation_software is None:
-            # preference to simtel output (multipipe)
-            simulation_software = "simtel" if self.simulator_array else "corsika"
+            # preference to sim_telarray output (multipipe)
+            simulation_software = "sim_telarray" if self.simulator_array else "corsika"
 
-        runner = self.corsika_runner if simulation_software == "corsika" else self.simulator_array
+        runner = (
+            self.corsika_runner
+            if simulation_software == "corsika"
+            else self.simulator_array[model_version_index]
+        )
         return runner.get_file_name(file_type=file_type, run_number=run_number, mode=mode)

simtools/runners/runner_services.py

@@ -52,6 +52,7 @@ class RunnerServices:
             "array_name": self.corsika_config.array_model.layout_name,
             "site": self.corsika_config.array_model.site,
             "label": self.label,
+            "model_version": self.corsika_config.array_model.model_version,
             "zenith": self.corsika_config.zenith_angle,
             "azimuth": self.corsika_config.azimuth_angle,
         }
@@ -70,8 +71,8 @@ class RunnerServices:
         """
         software_map = {
             "corsika": ["corsika"],
-            "simtel": ["simtel"],
-            "corsika_simtel": ["corsika", "simtel"],
+            "sim_telarray": ["sim_telarray"],
+            "corsika_sim_telarray": ["corsika", "sim_telarray"],
         }
         return software_map.get(simulation_software.lower(), [])
 
@@ -141,7 +142,8 @@ class RunnerServices:
         return (
             f"{run_dir}_{info_for_file_name['primary']}_"
             f"za{round(zenith):02}deg_azm{azimuth:03}deg_"
-            f"{info_for_file_name['site']}_{info_for_file_name['array_name']}{file_label}"
+            f"{info_for_file_name['site']}_{info_for_file_name['array_name']}_"
+            f"{info_for_file_name['model_version']}{file_label}"
         )
 
     def _get_log_file_path(self, file_type, file_name):
@@ -220,7 +222,13 @@ class RunnerServices:
         sub_log_file_dir.mkdir(parents=True, exist_ok=True)
         return sub_log_file_dir.joinpath(f"sub_{file_name}{suffix}")
 
-    def get_file_name(self, file_type, run_number=None, mode=None):
+    def get_file_name(
+        self,
+        file_type,
+        run_number=None,
+        mode=None,
+        _model_version_index=0,
+    ):  # pylint: disable=unused-argument
         """
         Get a CORSIKA/sim_telarray style file name for various log and data file types.
 
@@ -232,6 +240,11 @@ class RunnerServices:
             Run number.
         mode: str
             out or err (optional, relevant only for sub_log).
+        model_version_index: int
+            Index of the model version.
+            This is not used here, but in other implementations of this function is
+            used to select the correct simulator_array instance in case
+            multiple array models are simulated.
 
         Returns
         -------

simtools/runners/simtel_runner.py

@@ -12,7 +12,7 @@ __all__ = ["InvalidOutputFileError", "SimtelExecutionError", "SimtelRunner"]
 
 
 class SimtelExecutionError(Exception):
-    """Exception for simtel_array execution error."""
+    """Exception for sim_telarray execution error."""
 
 
 class InvalidOutputFileError(Exception):
@@ -21,7 +21,10 @@ class InvalidOutputFileError(Exception):
 
 class SimtelRunner:
     """
-    Base class for running sim_telarray simulations.
+    Base class for running simulations based on the sim_telarray software stack.
+
+    The sim_telarray software stack includes sim_telarray itself and e.g., testeff,
+    LightEmission, and other software packages.
 
     Parameters
     ----------
@@ -29,6 +32,10 @@ class SimtelRunner:
         Location of sim_telarray installation.
     label: str
         Instance label. Important for output file naming.
+    corsika_config: CorsikaConfig
+        CORSIKA configuration.
+    use_multipipe: bool
+        Use multipipe to run CORSIKA and sim_telarray.
     """
 
     def __init__(self, simtel_path, label=None, corsika_config=None, use_multipipe=False):
@@ -43,7 +50,7 @@ class SimtelRunner:
 
         self.runner_service = RunnerServices(corsika_config, label)
         self._directory = self.runner_service.load_data_directories(
-            "corsika_simtel" if use_multipipe else "simtel"
+            "corsika_sim_telarray" if use_multipipe else "sim_telarray"
         )
 
     def __repr__(self):
@@ -70,12 +77,8 @@ class SimtelRunner:
         Path
             Full path of the run script.
         """
-        self._logger.debug("Creating run bash 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)
@@ -216,7 +219,14 @@ class SimtelRunner:
         """Return computing resources used."""
         return self.runner_service.get_resources(run_number)
 
-    def get_file_name(self, simulation_software="simtel", file_type=None, run_number=None, mode=""):
+    def get_file_name(
+        self,
+        simulation_software="sim_telarray",
+        file_type=None,
+        run_number=None,
+        mode="",
+        model_version_index=0,
+    ):
         """
         Get the full path of a file for a given run number.
 
@@ -228,16 +238,23 @@ class SimtelRunner:
             File type.
         run_number: int
             Run number.
+        model_version_index: int
+            Index of the model version.
+            This is used to select the correct simulator_array instance in case
+            multiple array models are simulated.
 
         Returns
         -------
         str
             File name with full path.
         """
-        if simulation_software.lower() != "simtel":
+        if simulation_software.lower() != "sim_telarray":
             raise ValueError(
                 f"simulation_software ({simulation_software}) is not supported in SimulatorArray"
             )
         return self.runner_service.get_file_name(
-            file_type=file_type, run_number=run_number, mode=mode
+            file_type=file_type,
+            run_number=run_number,
+            mode=mode,
+            _model_version_index=model_version_index,
         )

simtools/schemas/model_parameter.metaschema.yml

@@ -91,6 +91,10 @@ definitions:
         anyOf:
           - type: string
         description: "Metaschema version."
+      model_parameter_schema_version:
+        anyOf:
+          - type: string
+        description: "Model parameter schema version."
       unique_id:
         anyOf:
           - type: string

simtools/schemas/model_parameter_and_data_schema.metaschema.yml

@@ -386,6 +386,7 @@ definitions:
       - sim_telarray
       - corsika
       - simtools
+      - testeff
     title: Name
   Source:
     type: string

simtools/schemas/model_parameters/adjust_gain.schema.yml

@@ -21,8 +21,8 @@ data:
 instrument:
   class: Camera
   type:
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/array_element_position_ground.schema.yml

@@ -24,8 +24,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/array_element_position_utm.schema.yml

@@ -24,8 +24,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/array_window.schema.yml

@@ -21,8 +21,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/asum_offset.schema.yml

@@ -19,8 +19,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/asum_shaping.schema.yml

@@ -19,8 +19,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/asum_threshold.schema.yml

@@ -21,8 +21,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/axes_offsets.schema.yml

@@ -37,8 +37,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_body_diameter.schema.yml

@@ -21,8 +21,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_body_shape.schema.yml

@@ -27,8 +27,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_config_file.schema.yml

@@ -21,8 +21,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_config_rotate.schema.yml

@@ -19,8 +19,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_degraded_efficiency.schema.yml

@@ -26,8 +26,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_degraded_map.schema.yml

@@ -25,8 +25,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_depth.schema.yml

@@ -23,8 +23,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_filter.schema.yml

@@ -28,8 +28,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_pixels.schema.yml

@@ -20,8 +20,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/camera_transmission.schema.yml

@@ -24,8 +24,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/channels_per_chip.schema.yml

@@ -21,8 +21,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity:

simtools/schemas/model_parameters/correct_nsb_spectrum_to_telescope_altitude.schema.yml

@@ -20,8 +20,8 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
+    - MSTx-NectarCam
+    - MSTx-FlashCam
     - SSTS
     - SCTS
 activity: