gammasimtools 0.12.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

simtools/applications/simulate_light_emission.py

@@ -1,136 +1,124 @@
 #!/usr/bin/python3
 
 r"""
-    Simulate calibration devices using the light emission package.
+Simulate calibration devices using the light emission package.
 
-    Run the application in the command line.
-    There are two ways this application can be executed:
+Run the application in the command line.
+There are two ways this application can be executed:
 
-    1. Illuminator at varying distances.
-    2. Illuminator and telescopes at fixed positions as defined in the layout.
+1. Illuminator at varying distances.
+2. Illuminator and telescopes at fixed positions as defined in the layout.
 
-    Example Usage
-    -------------
+Example Usage
+-------------
 
-    1. Simulate light emission with varying distances:
-
-        .. code-block:: console
-
-            simtools-simulate-light-emission --telescope MSTN-04 --site North \
-            --illuminator ILLN-01 --light_source_setup variable \
-            --model_version 6.0.0 --light_source_type led
-
-    2. Simulate light emission with telescopes at fixed positions according to the layout:
-
-        .. code-block:: console
-
-            simtools-simulate-light-emission --telescope MSTN-04 --site North \
-            --illuminator ILLN-01 --light_source_setup layout \
-            --model_version 6.0.0 \
-            --light_source_type led
-
-    Command Line Arguments
-    ----------------------
-
-    --telescope (str, required)
-        Telescope model name (e.g. LSTN-01, SSTS-design, SSTS-25, ...)
-
-    --site (str, required)
-        Site name (North or South).
-
-    --illuminator (str, optional)
-        Illuminator in array, e.g., ILLN-01.
-
-    --light_source_setup (str, optional)
-        Select calibration light source positioning/setup:
-        - "variable" for varying distances.
-        - "layout" for actual telescope positions.
-
-    --model_version (str, optional)
-        Version of the simulation model.
-
-    --light_source_type (str, optional)
-        Select calibration light source type: led (default) or laser.
-        This changes the pre-compiled (simtel_array) application that is used to run the
-        light emission package with. Currently we use xyzls (laser), and ls-beam can be
-        accessed by using the laser option.
-
-    --off_axis_angle (float, optional)
-        Off axis angle for light source direction.
-
-    --plot (flag, optional)
-        Produce a multiple pages pdf file with the image plots.
-
-
-    Example
-    -------
-
-    Simulate isotropic light source at different distances for the MSTN-04:
+1. Simulate light emission with varying distances:
 
     .. code-block:: console
 
         simtools-simulate-light-emission --telescope MSTN-04 --site North \
         --illuminator ILLN-01 --light_source_setup variable \
-        --model_version 6.0.0 --light_source_type led    ```
+        --model_version 6.0.0 --light_source_type led
 
-    Expected Output:
+2. Simulate light emission with telescopes at fixed positions according to the layout:
 
     .. code-block:: console
 
-        light-emission package stage:
-        File '/workdir/external/simtools/simtools-output/light_emission/model/
-            atmprof_ecmwf_north_winter_fixed.dat' registered for atmospheric profile 99.
-        Atmospheric profile 99 to be read from file '/workdir/external/simtools/
-            simtools-output/light_emission/model/atmprof_ecmwf_north_winter_fixed.dat'.
-        Atmospheric profile 99 with 55 levels read from file /workdir/external/
-            simtools/simtools-output/light_emission/model/atmprof_ecmwf_north_winter_fixed.dat
-        Initialize atmosphere ranging from 0.000 to 120.000 km a.s.l.
-        IACT control parameter line: print_events 999 10 100 1000 0
-        Case 1: 1 event with 1e+10 photons.
-        Using IACT/ATMO package version 1.67 (2023-11-10) for CORSIKA 6.999
-        Output file /workdir/external/simtools/simtools-output/light_emission/xyzls.iact.gz
-            not yet created.
-        Telescope output file: '/workdir/external/simtools/simtools-output/
-            light_emission/xyzls.iact.gz'
-        ....
-        ....
-        Sim_telarray stage:
-        Telescope 1 triggered (1/0/0/0, mask 1), summation from 36 to 95 of 105
-        Event end data has been found.
-        Shower of 0.0000 TeV energy was seen in 1 of 1 cases.
-        Photon statistics:
-        All photons:               928518
-        Used photons:              928518
-        Not absorbed/max. Q.E.:    189560
-        Reflected on mirror:        26815
-        Camera hit:                 25574
-        Pixel hit:                  25574
-        Detected:                   20998
-        Trigger statistics:
-        Tel. triggered:             1
-        Tel. + array:               1
-        Early readout:              0
-        Late readout:               0
-        Finish data conversion ...
-        Writing 13 histograms to output file.
-
+        simtools-simulate-light-emission --telescope MSTN-04 --site North \
+        --illuminator ILLN-01 --light_source_setup layout \
+        --model_version 6.0.0 \
+        --light_source_type led
+
+Command Line Arguments
+----------------------
+telescope (str, required)
+    Telescope model name (e.g. LSTN-01, SSTS-design, SSTS-25, ...)
+site (str, required)
+    Site name (North or South).
+illuminator (str, optional)
+    Illuminator in array, e.g., ILLN-01.
+light_source_setup (str, optional)
+    Select calibration light source positioning/setup:
+    - "variable" for varying distances.
+    - "layout" for actual telescope positions.
+model_version (str, optional)
+    Version of the simulation model.
+light_source_type (str, optional)
+    Select calibration light source type: led (default) or laser.
+    This changes the pre-compiled (simtel_array) application that is used to run the
+    light emission package with. Currently we use xyzls (laser), and ls-beam can be
+    accessed by using the laser option.
+off_axis_angle (float, optional)
+    Off axis angle for light source direction.
+plot (flag, optional)
+    Produce a multiple pages pdf file with the image plots.
+
+
+Example
+-------
+
+Simulate isotropic light source at different distances for the MSTN-04:
+
+.. code-block:: console
+
+    simtools-simulate-light-emission --telescope MSTN-04 --site North \
+    --illuminator ILLN-01 --light_source_setup variable \
+    --model_version 6.0.0 --light_source_type led    ```
+
+Expected Output:
+
+.. code-block:: console
+
+    light-emission package stage:
+    File '/workdir/external/simtools/simtools-output/light_emission/model/
+        atmprof_ecmwf_north_winter_fixed.dat' registered for atmospheric profile 99.
+    Atmospheric profile 99 to be read from file '/workdir/external/simtools/
+        simtools-output/light_emission/model/atmprof_ecmwf_north_winter_fixed.dat'.
+    Atmospheric profile 99 with 55 levels read from file /workdir/external/
+        simtools/simtools-output/light_emission/model/atmprof_ecmwf_north_winter_fixed.dat
+    Initialize atmosphere ranging from 0.000 to 120.000 km a.s.l.
+    IACT control parameter line: print_events 999 10 100 1000 0
+    Case 1: 1 event with 1e+10 photons.
+    Using IACT/ATMO package version 1.67 (2023-11-10) for CORSIKA 6.999
+    Output file /workdir/external/simtools/simtools-output/light_emission/xyzls.iact.gz
+        not yet created.
+    Telescope output file: '/workdir/external/simtools/simtools-output/
+        light_emission/xyzls.iact.gz'
+    ....
+    ....
+    Sim_telarray stage:
+    Telescope 1 triggered (1/0/0/0, mask 1), summation from 36 to 95 of 105
+    Event end data has been found.
+    Shower of 0.0000 TeV energy was seen in 1 of 1 cases.
+    Photon statistics:
+    All photons:               928518
+    Used photons:              928518
+    Not absorbed/max. Q.E.:    189560
+    Reflected on mirror:        26815
+    Camera hit:                 25574
+    Pixel hit:                  25574
+    Detected:                   20998
+    Trigger statistics:
+    Tel. triggered:             1
+    Tel. + array:               1
+    Early readout:              0
+    Late readout:               0
+    Finish data conversion ...
+    Writing 13 histograms to output file.
 
 """
 
 import logging
-import subprocess
 from pathlib import Path
 
 import astropy.units as u
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.corsika.corsika_histograms_visualize import save_figs_to_pdf
 from simtools.model.calibration_model import CalibrationModel
 from simtools.model.site_model import SiteModel
 from simtools.model.telescope_model import TelescopeModel
 from simtools.simtel.simulator_light_emission import SimulatorLightEmission
-from simtools.visualization.visualize import plot_simtel_ctapipe
 
 
 def _parse(label):
@@ -168,6 +156,7 @@ def _parse(label):
         type=str,
         choices=["layout", "variable"],
         default=None,
+        required=True,
     )
     config.parser.add_argument(
         "--distances_ls",
@@ -180,12 +169,7 @@ def _parse(label):
         help="Illuminator in array, i.e. ILLN-design",
         type=str,
         default=None,
-    )
-    config.parser.add_argument(
-        "--telescope_file",
-        help="Telescope position file (temporary)",
-        type=str,
-        default=None,
+        required=True,
     )
     config.parser.add_argument(
         "--return_cleaned",
@@ -239,27 +223,7 @@ def _parse(label):
     )
 
 
-def distance_list(arg):
-    """
-    Convert distance list to astropy quantities.
-
-    Parameters
-    ----------
-    arg: list
-        List of distances.
-
-    Returns
-    -------
-    values: list
-        List of distances as astropy quantities.
-    """
-    try:
-        return [float(x) * u.m for x in arg]
-    except ValueError as exc:
-        raise ValueError("Distances must be numeric values") from exc
-
-
-def default_le_configs(le_application, args_dict):
+def light_emission_configs(le_application, args_dict):
     """
     Define default light emission configurations.
 
@@ -285,18 +249,8 @@ def default_le_configs(le_application, args_dict):
     """
     if le_application in ("xyzls", "ls-beam") and args_dict["light_source_setup"] == "variable":
         return {
-            "x_pos": {
-                "len": 1,
-                "unit": u.Unit("cm"),
-                "default": 0 * u.cm,
-                "names": ["x_position"],
-            },
-            "y_pos": {
-                "len": 1,
-                "unit": u.Unit("cm"),
-                "default": 0 * u.cm,
-                "names": ["y_position"],
-            },
+            "x_pos": {"len": 1, "unit": u.Unit("cm"), "default": 0 * u.cm, "names": ["x_position"]},
+            "y_pos": {"len": 1, "unit": u.Unit("cm"), "default": 0 * u.cm, "names": ["y_position"]},
             "z_pos": {
                 "len": 1,
                 "unit": u.Unit("cm"),
@@ -310,7 +264,6 @@ def default_le_configs(le_application, args_dict):
                 "names": ["direction", "cx,cy,cz"],
             },
         }
-
     return {}
 
 
@@ -328,13 +281,11 @@ def select_application(args_dict):
     le_application: str
         Light emission application.
     """
-    le_application = None
     if args_dict["light_source_type"] == "led":
-        le_application = "xyzls"
-    elif args_dict["light_source_type"] == "laser":
-        le_application = "ls-beam"
-
-    return le_application, args_dict["light_source_setup"]
+        return "xyzls", args_dict["light_source_setup"]
+    if args_dict["light_source_type"] == "laser":
+        return "ls-beam", args_dict["light_source_setup"]
+    return None, args_dict["light_source_setup"]
 
 
 def main():
@@ -342,7 +293,8 @@ def main():
     label = Path(__file__).stem
     args_dict, db_config = _parse(label)
     le_application = select_application(args_dict)
-    default_le_config = default_le_configs(le_application[0], args_dict)
+    light_emission_config = light_emission_configs(le_application[0], args_dict)
+
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
@@ -369,105 +321,21 @@ def main():
         label=label,
     )
 
-    if args_dict["light_source_setup"] == "variable":
-        if args_dict["distances_ls"] is not None:
-            default_le_config["z_pos"]["default"] = distance_list(args_dict["distances_ls"])
-        logger.info(f"Simulating for distances of {default_le_config['z_pos']['default']}")
-        figures = []
-        for distance in default_le_config["z_pos"]["default"]:
-            le_config = default_le_config.copy()
-            le_config["z_pos"]["default"] = distance
-            light_source = SimulatorLightEmission(
-                telescope_model=telescope_model,
-                calibration_model=calibration_model,
-                site_model=site_model,
-                default_le_config=le_config,
-                le_application=le_application,
-                simtel_path=args_dict["simtel_path"],
-                light_source_type=args_dict["light_source_type"],
-            )
-            run_script = light_source.prepare_script(generate_postscript=True, **args_dict)
-            log_file = f"{light_source.output_directory}/logfile.log"
-            with open(log_file, "w", encoding="utf-8") as log_file:
-                subprocess.run(
-                    run_script,
-                    shell=False,
-                    check=False,
-                    text=True,
-                    stdout=log_file,
-                    stderr=log_file,
-                )
-
-                try:
-                    filename = (
-                        f"{light_source.output_directory}/"
-                        f"{light_source.le_application[0]}_"
-                        f"{light_source.le_application[1]}.simtel.gz"
-                    )
-                    fig = plot_simtel_ctapipe(
-                        filename,
-                        cleaning_args=[
-                            args_dict["boundary_thresh"],
-                            args_dict["picture_thresh"],
-                            args_dict["min_neighbors"],
-                        ],
-                        distance=light_source.default_le_config["z_pos"]["default"],
-                        return_cleaned=args_dict["return_cleaned"],
-                    )
-                    figures.append(fig)
-                except AttributeError:
-                    msg = "telescope not triggered at distance of"
-                    msg += f"{light_source.distance.to(u.meter)}"
-                    logger.warning(msg)
-
-                save_figs_to_pdf(
-                    figures,
-                    f"{light_source.output_directory}/{args_dict['telescope']}_"
-                    f"{light_source.le_application[0]}_"
-                    f"{light_source.le_application[1]}.pdf",
-                )
+    light_source = SimulatorLightEmission(
+        telescope_model=telescope_model,
+        calibration_model=calibration_model,
+        site_model=site_model,
+        light_emission_config=light_emission_config,
+        le_application=le_application,
+        simtel_path=args_dict["simtel_path"],
+        light_source_type=args_dict["light_source_type"],
+        label=label,
+    )
 
+    if args_dict["light_source_setup"] == "variable":
+        light_source.simulate_variable_distances(args_dict)
     elif args_dict["light_source_setup"] == "layout":
-        light_source = SimulatorLightEmission(
-            telescope_model=telescope_model,
-            calibration_model=calibration_model,
-            site_model=site_model,
-            default_le_config=default_le_config,
-            le_application=le_application,
-            simtel_path=args_dict["simtel_path"],
-            light_source_type=args_dict["light_source_type"],
-        )
-        run_script = light_source.prepare_script(generate_postscript=True, **args_dict)
-        log_file = f"{light_source.output_directory}/logfile.log"
-        with open(log_file, "w", encoding="utf-8") as log_file:
-            subprocess.run(
-                run_script, shell=False, check=False, text=True, stdout=log_file, stderr=log_file
-            )
-            try:
-                filename = (
-                    f"{light_source.output_directory}/"
-                    f"{light_source.le_application[0]}_{light_source.le_application[1]}.simtel.gz"
-                )
-                fig = plot_simtel_ctapipe(
-                    filename,
-                    cleaning_args=[
-                        args_dict["boundary_thresh"],
-                        args_dict["picture_thresh"],
-                        args_dict["min_neighbors"],
-                    ],
-                    distance=light_source.distance,
-                    return_cleaned=args_dict["return_cleaned"],
-                )
-            except AttributeError:
-                msg = f"telescope not triggered at distance of {light_source.distance.to(u.meter)}"
-                logger.warning(msg)
-
-        save_figs_to_pdf(
-            [fig],
-            f"{light_source.output_directory}/{args_dict['telescope']}_"
-            f"{light_source.le_application[0]}_"
-            f"{light_source.le_application[1]}.pdf",
-        )
+        light_source.simulate_layout_positions(args_dict)
 
 
 if __name__ == "__main__":

simtools/applications/simulate_prod_htcondor_generator.py

@@ -17,8 +17,8 @@ to the 'output_path' directory, with 'simtools-output' and 'logs' subdirectories
 
 Requirements for the 'simtools-simulate-prod-htcondor-generator' application:
 
-- Availability of an Apptainer image 'simtools-prod' (obtainable from the package registry on
-  GitHub, e.g., via 'apptainer pull --force docker://ghcr.io/gammasim/simtools-prod:latest').
+- Availability of an Apptainer image for production (obtainable from the package registry on
+  GitHub, e.g., via 'apptainer pull --force docker://ghcr.io/gammasim/simtools-<tag>:latest').
 - Environment parameters required to run CORSIKA and sim_telarray, as well as DB access
   credentials.  These should be listed similarly to a '.env' file and copied to
   'output_path/env.txt'.  Ensure that the path to the simulation software is correctly set to

simtools/applications/submit_data_from_external.py

@@ -112,7 +112,7 @@ def main():  # noqa: D103
 
     writer.ModelDataWriter.dump(
         args_dict=args_dict,
-        metadata=_metadata.get_top_level_metadata() if _metadata else None,
+        metadata=_metadata,
         product_data=data_validator.validate_and_transform(),
     )
 

simtools/applications/submit_model_parameter_from_external.py

@@ -85,8 +85,9 @@ def _parse(label, description):
     )
     config.parser.add_argument(
         "--input_meta",
-        help="meta data file associated to input data",
+        help="meta data file(s) associated to input data (wildcards or list of files allowed)",
         type=str,
+        nargs="+",
         required=False,
     )
     config.parser.add_argument(