gammasimtools 0.18.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

simtools/applications/simulate_flasher.py

@@ -0,0 +1,141 @@
+#!/usr/bin/python3
+
+r"""
+Simulate flasher devices using the light emission package.
+
+Run the application in the command line.
+
+Example Usage
+-------------
+
+1. Simulate flashers for a telescope:
+
+    .. code-block:: console
+
+        simtools-simulate-flasher --telescope MSTN-04 --site North \
+        --flasher FLSN-01 --model_version 6.0.0
+
+Command Line Arguments
+----------------------
+telescope (str, required)
+    Telescope model name (e.g. LSTN-01, MSTN-04, SSTS-04, ...)
+site (str, required)
+    Site name (North or South).
+flasher (str, required)
+    Flasher device in array, e.g., FLSN-01.
+number_of_events (int, optional):
+    Number of events to simulate (default: 1).
+output_prefix (str, optional):
+    Prefix for output files (default: empty).
+model_version (str, optional)
+    Version of the simulation model.
+
+Example
+-------
+
+Simulate flashers for MSTN-04:
+
+.. code-block:: console
+
+    simtools-simulate-flasher --telescope MSTN-04 --site North \
+    --flasher FLSN-01 --model_version 6.0.0
+
+Expected Output:
+    The simulation will run the light emission package for the flasher
+    devices and produce the output files.
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.model.flasher_model import FlasherModel
+from simtools.model.model_utils import initialize_simulation_models
+from simtools.simtel.simulator_light_emission import SimulatorLightEmission
+
+
+def _parse(label):
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=label,
+        description=("Simulate flasher devices using the light emission package."),
+    )
+    config.parser.add_argument(
+        "--flasher",
+        help="Flasher device in array associated with a specific telescope, i.e. FLSN-01",
+        type=str,
+        required=True,
+    )
+    config.parser.add_argument(
+        "--number_events",
+        help="Number of number_events to simulate (default: 1)",
+        type=int,
+        default=1,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--output_prefix",
+        help="Prefix for output files (default: empty)",
+        type=str,
+        default=None,
+        required=False,
+    )
+
+    return config.initialize(
+        db_config=True,
+        simulation_model=["telescope", "model_version"],
+        require_command_line=True,
+    )
+
+
+def flasher_configs():
+    """Return default setup for flasher runs (no distances)."""
+    return {"light_source_setup": "layout"}
+
+
+def main():
+    """Run the application."""
+    label = Path(__file__).stem
+    logger = logging.getLogger(__name__)
+
+    args_dict, db_config = _parse(label)
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    telescope_model, site_model = initialize_simulation_models(
+        label=label,
+        db_config=db_config,
+        site=args_dict["site"],
+        telescope_name=args_dict["telescope"],
+        model_version=args_dict["model_version"],
+    )
+
+    flasher_model = FlasherModel(
+        site=args_dict["site"],
+        flasher_device_model_name=args_dict["flasher"],
+        mongo_db_config=db_config,
+        model_version=args_dict["model_version"],
+        label=label,
+    )
+
+    flasher_cfg = flasher_configs()
+
+    sim_runner = SimulatorLightEmission(
+        telescope_model=telescope_model,
+        flasher_model=flasher_model,
+        site_model=site_model,
+        light_emission_config=args_dict,
+        light_source_setup=flasher_cfg["light_source_setup"],
+        simtel_path=args_dict["simtel_path"],
+        light_source_type="flasher",
+        label=args_dict["label"],
+        test=args_dict.get("test", False),
+    )
+
+    sim_runner.run_simulation()
+
+    logger.info("Flasher simulation completed. Use simtools-plot-simtel-number_events for plots.")
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/{simulate_light_emission.py → simulate_illuminator.py}

@@ -16,18 +16,17 @@ Example Usage
 
     .. code-block:: console
 
-        simtools-simulate-light-emission --telescope MSTN-04 --site North \
+        simtools-simulate-illuminator --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
 
 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 \
+        simtools-simulate-illuminator --telescope MSTN-04 --site North \
         --illuminator ILLN-01 --light_source_setup layout \
-        --model_version 6.0.0 \
-        --light_source_type led
+        --model_version 6.0.0
 
 Command Line Arguments
 ----------------------
@@ -43,15 +42,10 @@ light_source_setup (str, optional)
     - "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 (sim_telarray) 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.
+number_events (int, optional)
+    Number of events to simulate.
 
 
 Example
@@ -61,9 +55,9 @@ Simulate isotropic light source at different distances for the MSTN-04:
 
 .. code-block:: console
 
-    simtools-simulate-light-emission --telescope MSTN-04 --site North \
+    simtools-simulate-illuminator --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    ```
 
 Expected Output:
 
@@ -135,19 +129,7 @@ def _parse(label):
         default=0.0,
         required=False,
     )
-    config.parser.add_argument(
-        "--plot",
-        help="Produce a multiple pages pdf file with the image plots.",
-        action="store_true",
-    )
-    config.parser.add_argument(
-        "--light_source_type",
-        help="Select calibration light source type: led or laser",
-        type=str,
-        default="led",
-        choices=["led", "laser"],
-        required=False,
-    )
+
     config.parser.add_argument(
         "--light_source_setup",
         help="Select calibration light source positioning/setup: \
@@ -171,48 +153,17 @@ def _parse(label):
         required=True,
     )
     config.parser.add_argument(
-        "--return_cleaned",
-        help="ctapipe, if image should be cleaned, \
-              notice as well image cleaning parameters",
-        type=str,
-        default=False,
-        required=False,
-    )
-    config.parser.add_argument(
-        "--picture_thresh",
-        help="ctapipe, threshold above which all pixels are retained",
-        type=int,
-        required=False,
-    )
-    config.parser.add_argument(
-        "--boundary_thresh",
-        help="ctapipe, threshold above which pixels are retained if\
-              they have a neighbor already above the picture_thresh",
-        type=int,
-        required=False,
-    )
-    config.parser.add_argument(
-        "--min_neighbors",
-        help="ctapipe, A picture pixel survives cleaning only if it has at\
-              least this number of picture neighbors. This has no effect in\
-              case keep_isolated_pixels is True",
-        type=int,
-        required=False,
-    )
-    config.parser.add_argument(
-        "--level",
-        help="read 5",
+        "--number_events",
+        help="Number of events to simulate",
         type=int,
-        default=5,
+        default=1,
         required=False,
     )
     config.parser.add_argument(
-        "--integration_window",
-        help="ctapipe, A picture pixel survives cleaning only if it has at\
-              least this number of picture neighbors. This has no effect in\
-              case keep_isolated_pixels is True",
-        nargs="*",
-        default=["7", "3"],
+        "--output_prefix",
+        help="Prefix for output files (default: empty)",
+        type=str,
+        default=None,
         required=False,
     )
     return config.initialize(
@@ -222,7 +173,7 @@ def _parse(label):
     )
 
 
-def light_emission_configs(le_application, args_dict):
+def light_emission_configs(args_dict):
     """
     Define default light emission configurations.
 
@@ -235,8 +186,8 @@ def light_emission_configs(le_application, args_dict):
 
     Parameters
     ----------
-    le_application: str
-        Light emission application.
+    args_dict: dict
+        Dictionary with command line arguments.
 
     args_dict: dict
         Dictionary with command line arguments.
@@ -246,8 +197,8 @@ def light_emission_configs(le_application, args_dict):
     default_config: dict
         Default light emission configuration.
     """
-    if le_application in ("xyzls", "ls-beam") and args_dict["light_source_setup"] == "variable":
-        return {
+    if args_dict["light_source_setup"] == "variable":
+        cfg = {
             "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": {
@@ -263,37 +214,17 @@ def light_emission_configs(le_application, args_dict):
                 "names": ["direction", "cx,cy,cz"],
             },
         }
-    return {}
-
-
-def select_application(args_dict):
-    """
-    Select sim_telarray application for light emission simulations.
-
-    Parameters
-    ----------
-    args_dict: dict
-        Dictionary with command line arguments.
-
-    Returns
-    -------
-    le_application: str
-        Light emission application.
-    """
-    if args_dict["light_source_type"] == "led":
-        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"]
+        args_dict.update(cfg)
+        return args_dict
+    return args_dict
 
 
 def main():
     """Simulate light emission."""
     label = Path(__file__).stem
     args_dict, db_config = _parse(label)
-    le_application = select_application(args_dict)
-    light_emission_config = light_emission_configs(le_application[0], args_dict)
-
+    light_emission_config = light_emission_configs(args_dict)
+    print(light_emission_config)
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
@@ -318,17 +249,22 @@ def main():
         calibration_model=calibration_model,
         site_model=site_model,
         light_emission_config=light_emission_config,
-        le_application=le_application,
+        light_source_setup=args_dict["light_source_setup"],
         simtel_path=args_dict["simtel_path"],
-        light_source_type=args_dict["light_source_type"],
+        light_source_type="illuminator",
         label=label,
         test=args_dict["test"],
     )
 
     if args_dict["light_source_setup"] == "variable":
-        light_source.simulate_variable_distances(args_dict)
+        outputs = light_source.simulate_variable_distances(args_dict)
     elif args_dict["light_source_setup"] == "layout":
-        light_source.simulate_layout_positions(args_dict)
+        outputs = light_source.simulate_layout_positions(args_dict)
+    else:
+        outputs = []
+
+    if outputs:
+        logger.info("Simulation outputs:\n%s", "\n".join(str(p) for p in outputs))
 
 
 if __name__ == "__main__":

simtools/applications/simulate_prod.py

@@ -141,30 +141,14 @@ def _parse(description=None):
         action="store_true",
         default=False,
     )
-    sim_telarray_seed_group = config.parser.add_argument_group(
-        title="Random seeds for sim_telarray instrument setup",
-    )
-    sim_telarray_seed_group.add_argument(
-        "--sim_telarray_instrument_seeds",
-        help=(
-            "Random seed used for sim_telarray instrument setup. "
-            "If '--sim_telarray_random_instrument_instances is not set: use as sim_telarray seed "
-            " ('random_seed' parameter). "
-            "Otherwise: use as base seed for the generation of random instrument instance seeds."
-        ),
-        type=str,
-        required=False,
-    )
-    sim_telarray_seed_group.add_argument(
-        "--sim_telarray_random_instrument_instances",
-        help="Number of random instrument instances initialized in sim_telarray.",
-        type=int,
-        required=False,
-    )
     return config.initialize(
         db_config=True,
         simulation_model=["site", "layout", "telescope", "model_version"],
-        simulation_configuration={"software": None, "corsika_configuration": ["all"]},
+        simulation_configuration={
+            "software": None,
+            "corsika_configuration": ["all"],
+            "sim_telarray_configuration": ["all"],
+        },
     )
 
 
@@ -174,9 +158,7 @@ def main():  # noqa: D103
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
-    simulator = Simulator(
-        label=args_dict.get("label"), args_dict=args_dict, mongo_db_config=db_config
-    )
+    simulator = Simulator(label=args_dict.get("label"), args_dict=args_dict, db_config=db_config)
 
     simulator.simulate()
     simulator.validate_metadata()

simtools/applications/simulate_prod_htcondor_generator.py

@@ -24,6 +24,13 @@ Requirements for the 'simtools-simulate-prod-htcondor-generator' application:
   'output_path/env.txt'.  Ensure that the path to the simulation software is correctly set to
   'SIMTOOLS_SIMTEL_PATH=/workdir/sim_telarray'.
 
+To submit jobs, change to the output directory and run:
+
+.. code-block:: console
+
+    condor_submit simulate_prod.submit
+
+Simulation data products will be stored in the output directory.
 
 Command line arguments
 ----------------------

simtools/applications/submit_array_layouts.py

@@ -38,6 +38,7 @@ from pathlib import Path
 import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.db import db_handler
+from simtools.io import ascii_handler
 from simtools.layout.array_layout_utils import validate_array_layouts_with_db, write_array_layouts
 
 
@@ -83,7 +84,7 @@ def main():  # noqa: D103
         production_table=db.read_production_table_from_mongo_db(
             collection_name="telescopes", model_version=args_dict["model_version"]
         ),
-        array_layouts=gen.collect_data_from_file(args_dict["array_layouts"]),
+        array_layouts=ascii_handler.collect_data_from_file(args_dict["array_layouts"]),
     )
 
     write_array_layouts(array_layouts=array_layouts, args_dict=args_dict, db_config=db_config)

simtools/applications/submit_model_parameter_from_external.py

@@ -108,7 +108,7 @@ def main():  # noqa: D103
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
     output_path = (
-        Path(args_dict["output_path"]) / args_dict["instrument"] / args_dict["parameter"]
+        Path(args_dict["output_path"]) / args_dict["parameter"]
         if args_dict.get("output_path")
         else None
     )

simtools/applications/validate_camera_efficiency.py

@@ -1,10 +1,11 @@
 #!/usr/bin/python3
 
 r"""
-    Validate the camera efficiency by simulating it using the sim_telarray testeff program.
+    Calculate on-axis telescope throughput and NSB pixels rates.
 
-    The results of camera efficiency for Cherenkov (left) and NSB light (right) as a function\
-    of wavelength are plotted. See examples below.
+    Uses the sim_telarray tool "testeff" to calculate the camera efficiency.
+    The results of telescope throughput including optical and camera components for Cherenkov (left)
+    and NSB light (right) as a function of wavelength are plotted. See examples below.
 
     .. _validate_camera_eff_plot:
     .. image:: images/validate_camera_efficiency_North-MST-NectarCam-D_cherenkov.png
@@ -19,7 +20,7 @@ r"""
     telescope (str, required)
         Telescope model name (e.g. LSTN-01, SSTS-15)
     model_version (str, optional)
-        Model version
+        Simulation model version
     zenith_angle (float, optional)
         Zenith angle in degrees (between 0 and 180).
     azimuth_angle (float, optional)
@@ -46,6 +47,7 @@ r"""
 import logging
 from pathlib import Path
 
+import simtools.data_model.model_data_writer as writer
 import simtools.utils.general as gen
 from simtools.camera.camera_efficiency import CameraEfficiency
 from simtools.configuration import configurator
@@ -56,8 +58,8 @@ def _parse(label):
     config = configurator.Configurator(
         label=label,
         description=(
-            "Calculate the camera efficiency of the telescope requested. "
-            "Plot the camera efficiency vs wavelength for cherenkov and NSB light."
+            "Calculate the camera efficiency and NSB pixel rates. "
+            "Plot the camera efficiency vs wavelength for Cherenkov and NSB light."
         ),
     )
     config.parser.add_argument(
@@ -76,17 +78,22 @@ def _parse(label):
     config.parser.add_argument(
         "--skip_correction_to_nsb_spectrum",
         help=(
-            "Apply a correction to the NSB spectrum to account for the "
+            "Skip correction to the NSB spectrum to account for the "
             "difference between the altitude used in the reference B&E spectrum and "
             "the observation level at the CTAO sites."
-            "This correction is done internally in sim_telarray and is on by default."
         ),
         required=False,
         action="store_true",
     )
+    config.parser.add_argument(
+        "--write_reference_nsb_rate_as_parameter",
+        help=("Write the NSB pixel rate obtained for reference conditions as a model parameter "),
+        action="store_true",
+        required=False,
+    )
     _args_dict, _db_config = config.initialize(
         db_config=True,
-        simulation_model=["telescope", "model_version"],
+        simulation_model=["telescope", "model_version", "parameter_version"],
         simulation_configuration={"corsika_configuration": ["zenith_angle", "azimuth_angle"]},
     )
     if _args_dict["site"] is None or _args_dict["telescope"] is None:
@@ -98,14 +105,13 @@ def _parse(label):
 
 def main():  # noqa: D103
     label = Path(__file__).stem
-    args_dict, _db_config = _parse(label)
+    args_dict, db_config = _parse(label)
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
     ce = CameraEfficiency(
-        db_config=_db_config,
-        simtel_path=args_dict["simtel_path"],
+        db_config=db_config,
         label=args_dict.get("label", label),
         config_data=args_dict,
     )
@@ -114,6 +120,18 @@ def main():  # noqa: D103
     ce.plot_efficiency(efficiency_type="Cherenkov", save_fig=True)
     ce.plot_efficiency(efficiency_type="NSB", save_fig=True)
 
+    writer.ModelDataWriter.dump_model_parameter(
+        parameter_name="nsb_pixel_rate",
+        value=ce.get_nsb_pixel_rate(
+            reference_conditions=args_dict.get("write_reference_nsb_rate_as_parameter", False)
+        ),
+        instrument=args_dict["telescope"],
+        parameter_version=args_dict.get("parameter_version", "0.0.0"),
+        output_file=Path(f"nsb_pixel_rate-{args_dict.get('parameter_version', '0.0.0')}.json"),
+        output_path=Path(args_dict["output_path"]) / args_dict["telescope"] / "nsb_pixel_rate",
+        use_plain_output_path=args_dict.get("use_plain_output_path"),
+    )
+
 
 if __name__ == "__main__":
     main()

simtools/applications/validate_camera_fov.py

@@ -52,7 +52,7 @@ from pathlib import Path
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.io_operations import io_handler
+from simtools.io import io_handler
 from simtools.model.telescope_model import TelescopeModel
 from simtools.visualization import plot_camera, visualize
 

simtools/applications/validate_cumulative_psf.py

@@ -79,7 +79,7 @@ import numpy as np
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.io_operations import io_handler
+from simtools.io import io_handler
 from simtools.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize

simtools/applications/validate_file_using_schema.py

@@ -40,6 +40,7 @@ import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.constants import MODEL_PARAMETER_SCHEMA_PATH
 from simtools.data_model import metadata_collector, schema, validate_data
+from simtools.io import ascii_handler
 
 
 def _parse(label, description):
@@ -140,14 +141,17 @@ def validate_dict_using_schema(args_dict, logger):
         args_dict.get("file_directory"), args_dict.get("file_name")
     ):
         try:
-            data = gen.collect_data_from_file(file_name=file_name)
+            data = ascii_handler.collect_data_from_file(file_name=file_name)
         except FileNotFoundError as exc:
             raise FileNotFoundError(f"Error reading schema file from {file_name}") from exc
         data = data if isinstance(data, list) else [data]
-        for data_dict in data:
-            schema.validate_dict_using_schema(
-                data_dict, _get_schema_file_name(args_dict, data_dict)
-            )
+        try:
+            for data_dict in data:
+                schema.validate_dict_using_schema(
+                    data_dict, _get_schema_file_name(args_dict, data_dict)
+                )
+        except Exception as exc:
+            raise ValueError(f"Validation of file {file_name} failed") from exc
         logger.info(f"Successful validation of file {file_name}")
 
 

simtools/applications/validate_optics.py

@@ -75,7 +75,7 @@ from matplotlib.backends.backend_pdf import PdfPages
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.io_operations import io_handler
+from simtools.io import io_handler
 from simtools.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize