gammasimtools 0.8.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

simtools/applications/derive_photon_electron_spectrum.py

@@ -0,0 +1,99 @@
+#!/usr/bin/python3
+
+r"""
+    Derive single photon electron spectrum from a given amplitude spectrum.
+
+    Normalizes singe-p.e. amplitude distribution to mean amplitude of 1.0,
+    as required by sim_telarray. Allows to fold in afterpulse distribution
+    to prompt a spectrum. Uses the sim_telarray tool 'norm_spe' to normalize
+    the spectra.
+
+    Input files can be in ecsv format (preferred) or in the sim_telarray legacy format.
+
+    Two output files with identical data are written to the output directory:
+
+    - 'output_file'.ecsv: Single photon electron spectrum in ecsv format (data and metadata).
+    - 'output_file'.dat: Single photon electron spectrum in sim_telarray format.
+
+    Example
+    -------
+
+    .. code-block:: console
+
+        simtools-derive-photon-electron-spectrum \\
+            --input_spectrum spectrum_photon_electron.ecsv \\
+            --afterpulse_spectrum spectrum_afterpulse.ecsv \\
+            --step_size 0.02 \\
+            --max_amplitude 42.0 \\
+            --use_norm_spe \\
+            --output_path ./tests/output \\
+            --output_file spectrum_photon_electron_afterpulse.ecsv
+
+    For an example of how to plot the single photon electron spectrum, see the
+    integration test 'tests/integration_tests/config/plot_tabular_data_for_single_pe_data.yml'.
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.camera.single_photon_electron_spectrum import SinglePhotonElectronSpectrum
+from simtools.configuration import configurator
+
+
+def _parse(label):
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=label,
+        description="Derive single photon electron spectrum from a given amplitude spectrum.",
+    )
+    config.parser.add_argument(
+        "--input_spectrum",
+        help="File with amplitude spectrum.",
+        type=Path,
+        required=True,
+    )
+    config.parser.add_argument(
+        "--afterpulse_spectrum",
+        help="File with afterpulse spectrum.",
+        type=Path,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--step_size",
+        help="Step size in amplitude spectrum",
+        type=float,
+        default=0.02,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--max_amplitude",
+        help="Maximum amplitude in amplitude spectrum",
+        type=float,
+        default=42.0,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--use_norm_spe",
+        help="Use sim_telarray tool 'norm_spe' to normalize the spectrum.",
+        action="store_true",
+        required=False,
+    )
+
+    return config.initialize(db_config=False, output=True)
+
+
+def main():  # noqa: D103
+    args_dict, _ = _parse(Path(__file__).stem)
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    single_pe = SinglePhotonElectronSpectrum(args_dict)
+    single_pe.derive_single_pe_spectrum()
+    single_pe.write_single_pe_spectrum()
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/derive_psf_parameters.py

@@ -150,7 +150,7 @@ def _parse():
         help=("Keep the first entry of mirror_reflection_random_angle fixed."),
         action="store_true",
     )
-    return config.initialize(db_config=True, simulation_model="telescope")
+    return config.initialize(db_config=True, simulation_model=["telescope", "model_version"])
 
 
 def add_parameters(

simtools/applications/generate_array_config.py

@@ -1,32 +1,28 @@
 #!/usr/bin/python3
 """
-    Generate sim_telarray configuration files for a given array.
+Generate sim_telarray configuration files for a given array.
 
-    The applications generates the sim_telarray configuration files for a given array, site,
-    and model_version using the model parameters stored in the database.
+The applications generates the sim_telarray configuration files for a given array, site,
+and model_version using the model parameters stored in the database.
 
-    To change model parameters, clone the model parameters repository and apply the changes.
-    Forward the path to the repository to the application using the ``--db_simulation_model_url``
-    argument.
+Command line arguments
+----------------------
+site : str
+    Site name (e.g., North, South).
+array_layout_name : str
+    Name of the layout array (e.g., test_layout, alpha, 4mst, etc.).
+array_element_list : list
+    List of array elements (e.g., telescopes) to plot (e.g., ``LSTN-01 LSTN-02 MSTN``).
 
-    Command line arguments
-    ----------------------
-    site : str
-        Site name (e.g., North, South).
-    array_layout_name : str
-        Name of the layout array (e.g., test_layout, alpha, 4mst, etc.).
-    array_element_list : list
-        List of array elements (e.g., telescopes) to plot (e.g., ``LSTN-01 LSTN-02 MSTN``).
+Example
+-------
+North - 5.0.0:
 
-    Example
-    -------
-    North - 5.0.0:
-
-    .. code-block:: console
+.. code-block:: console
 
-        simtools-generate-array-config --site North --array_layout_name alpha --model_version 5.0.0
+    simtools-generate-array-config --site North --array_layout_name alpha --model_version 5.0.0
 
-    The output is saved in simtools-output/test/model.
+The output is saved in simtools-output/test/model.
 """
 
 import logging
@@ -54,7 +50,7 @@ def _parse(label, description):
         Command line parser object.
     """
     config = configurator.Configurator(label=label, description=description)
-    return config.initialize(db_config=True, simulation_model=["site", "layout"])
+    return config.initialize(db_config=True, simulation_model=["site", "layout", "model_version"])
 
 
 def main():

simtools/applications/generate_regular_arrays.py

@@ -1,31 +1,30 @@
 #!/usr/bin/python3
 
 """
-    Make a regular array of telescopes and save it as astropy table.
+Make a regular array of telescopes and save it as astropy table.
 
-    The arrays consist of one telescope at the center of the array and or of 4 telescopes
-    in a square grid. These arrays are used for trigger rate simulations.
+The arrays consist of one telescope at the center of the array and or of 4 telescopes
+in a square grid. These arrays are used for trigger rate simulations.
 
-    The array layout files created will be available at the data/layout directory.
+The array layout files created will be available at the data/layout directory.
 
-    Command line arguments
-    ----------------------
-    site (str, required)
-        observatory site (e.g., North or South).
-    model_version (str, optional)
-        Model version to use (e.g., 6.0.0). If not provided, the latest version is used.
+Command line arguments
+----------------------
+site (str, required)
+    observatory site (e.g., North or South).
+model_version (str, optional)
+    Model version to use (e.g., 6.0.0). If not provided, the latest version is used.
 
-    Example
-    -------
-    Runtime < 10 s.
+Example
+-------
+Runtime < 10 s.
 
-    .. code-block:: console
+.. code-block:: console
 
-        simtools-generate-regular-arrays --site=North
+    simtools-generate-regular-arrays --site=North
 """
 
 import logging
-import os
 from pathlib import Path
 
 import astropy.units as u
@@ -52,7 +51,9 @@ def _parse():
             f"  SST: {telescope_distance['SST']}\n"
         ),
     )
-    return config.initialize(db_config=False, simulation_model="site", output=True)
+    return config.initialize(
+        db_config=False, simulation_model=["site", "model_version"], output=True
+    )
 
 
 def main():
@@ -101,10 +102,12 @@ def main():
         table.sort("telescope_name")
         table.pprint()
 
-        output_file = args_dict.get("output_file", None)
-        if output_file is not None:
-            base_name, file_extension = os.path.splitext(output_file)
-            output_file = f"{base_name}-{args_dict['site']}-{array_name}{file_extension}"
+        output_file = args_dict.get("output_file")
+        if output_file:
+            output_path = Path(output_file)
+            output_file = output_path.with_name(
+                f"{output_path.stem}-{args_dict['site']}-{array_name}{output_path.suffix}"
+            )
         writer.ModelDataWriter.dump(
             args_dict=args_dict,
             output_file=output_file,

simtools/applications/generate_simtel_array_histograms.py

@@ -13,8 +13,6 @@ r"""
         Name of the histogram files to be plotted.
         It can be given as the histogram file names (more than one option allowed) or as a text
         file with the names of the histogram files in it.
-    figure_name (str, required)
-        File name for the pdf output (without extension).
     pdf (bool, optional)
         If set, histograms are saved into pdf files.
         One pdf file contains all the histograms found in the file.
@@ -29,6 +27,8 @@ r"""
         If the output output_file_name.hdf5 file already exists and hdf5 is set, the tables
         associated to hdf5 will be overwritten. The remaining tables, if any, will stay
         untouched.
+    test: bool
+        Test option. Generate only two histograms for testing purposes.
 
     Raises
     ------
@@ -108,38 +108,6 @@ def _parse(label, description):
     return config_parser
 
 
-def build_histogram_files(config_parser, logger):
-    """
-    Build a list of histogram files from command line arguments.
-
-    Parameters
-    ----------
-    config_parser: dict
-        Parsed command line arguments.
-    logger: logging.Logger
-        Logger object for logging messages.
-
-    Returns
-    -------
-    list
-        List of histogram file paths.
-    """
-    histogram_files = []
-    for one_file in config_parser["hist_file_names"]:
-        try:
-            if Path(one_file).suffix in [".zst", ".simtel", ".hdata"]:
-                histogram_files.append(one_file)
-            else:
-                with open(one_file, encoding="utf-8") as file:
-                    for line in file:
-                        histogram_files.append(line.strip())
-        except FileNotFoundError as exc:
-            msg = f"{one_file} is not a file."
-            logger.error(msg)
-            raise FileNotFoundError from exc
-    return histogram_files
-
-
 def check_and_log_overwrite(config_parser, logger):
     """
     Check if the output hdf5 file already exists and log a warning if it does.
@@ -197,36 +165,31 @@ def create_pdf(simtel_histograms, output_file_name, config_parser, logger):
         logger.info(f"Wrote histograms to the pdf file {output_file_name}.pdf")
 
 
-def export_to_hdf5(simtel_histograms, output_file_name, overwrite, config_parser, logger):
-    """Export histograms to an HDF5 file."""
-    if config_parser["hdf5"]:
-        logger.info(f"Wrote histograms to the hdf5 file {output_file_name}.hdf5")
-        simtel_histograms.export_histograms(f"{output_file_name}.hdf5", overwrite=overwrite)
-
-
 def main():  # noqa: D103
     label = Path(__file__).stem
-    description = "Display the simtel_array histograms."
+    description = "Display simtel_array histograms and/or write them into hdf5 format."
     io_handler_instance = io_handler.IOHandler()
     config_parser = _parse(label, description)
     output_path = io_handler_instance.get_output_directory(label, sub_dir="application-plots")
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(config_parser["log_level"]))
-    logger.info("Starting the application.")
 
-    histogram_files = build_histogram_files(config_parser, logger)
+    histogram_files = gen.get_list_of_files_from_command_line(
+        config_parser["hist_file_names"], [".zst", ".simtel", ".hdata"]
+    )
 
     # If no output name is passed, the tool gets the name of the first histogram of the list
     if config_parser["output_file_name"] is None:
         config_parser["output_file_name"] = Path(histogram_files[0]).absolute().name
     output_file_name = Path(output_path).joinpath(f"{config_parser['output_file_name']}")
 
-    # If the hdf5 output file already exists, it is overwritten
-    overwrite = check_and_log_overwrite(config_parser, logger)
-
     simtel_histograms = SimtelIOHistograms(histogram_files)
     create_pdf(simtel_histograms, output_file_name, config_parser, logger)
-    export_to_hdf5(simtel_histograms, output_file_name, overwrite, config_parser, logger)
+    if config_parser["hdf5"]:
+        simtel_histograms.export_histograms(
+            f"{output_file_name}.hdf5",
+            overwrite=check_and_log_overwrite(config_parser, logger),
+        )
 
 
 if __name__ == "__main__":

simtools/applications/plot_array_layout.py

@@ -146,7 +146,9 @@ def _parse(label, description, usage):
         required=False,
         default=None,
     )
-    return config.initialize(db_config=True, simulation_model=["site", "layout", "layout_file"])
+    return config.initialize(
+        db_config=True, simulation_model=["site", "model_version", "layout", "layout_file"]
+    )
 
 
 def _get_site_from_telescope_list_name(telescope_list_file):

simtools/applications/plot_tabular_data.py

@@ -0,0 +1,84 @@
+#!/usr/bin/python3
+"""
+Plot tabular data read from file or from model parameter database.
+
+Uses a configuration file to define the data to be plotted and all
+plotting details.
+
+Command line arguments
+----------------------
+config_file (str, required)
+    Configuration file name for plotting.
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.io_operations import io_handler
+from simtools.visualization import plot_tables
+
+
+def _parse(label, description, usage):
+    """
+    Parse command line configuration.
+
+    Parameters
+    ----------
+    label : str
+        Label describing the application.
+    description : str
+        Description of the application.
+    usage : str
+        Example on how to use the application.
+
+    Returns
+    -------
+    CommandLineParser
+        Command line parser object.
+    """
+    config = configurator.Configurator(label=label, description=description, usage=usage)
+
+    config.parser.add_argument(
+        "--plot_config",
+        help="Plotting configuration file name.",
+        type=str,
+        required=True,
+        default=None,
+    )
+    config.parser.add_argument(
+        "--output_file",
+        help="Output file name (without suffix)",
+        type=str,
+        required=True,
+    )
+    return config.initialize(db_config=True)
+
+
+def main():
+    """Plot tabular data."""
+    args_dict, db_config_ = _parse(
+        label=Path(__file__).stem,
+        description="Plots tabular data.",
+        usage="""simtools-plot-tabular-data --plot_config config_file_name "
+                 --output_file output_file_name""",
+    )
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict.get("log_level", "INFO")))
+    io_handler_instance = io_handler.IOHandler()
+
+    plot_config = gen.convert_keys_in_dict_to_lowercase(
+        gen.collect_data_from_file(args_dict["plot_config"])
+    )
+
+    plot_tables.plot(
+        config=plot_config["cta_simpipe"]["plot"],
+        output_file=io_handler_instance.get_output_file(args_dict["output_file"]),
+        db_config=db_config_,
+    )
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/production_generate_simulation_config.py

@@ -1,11 +1,24 @@
 #!/usr/bin/python3
 
 r"""
-Configure a simulation based on command-line arguments.
+Derive simulation configuration parameters for a simulation production.
 
-This application configures and
-generates simulation parameters for a specific grid point in a statistical uncertainty
-evaluation setup.
+Derived simulation configuration parameters include:
+
+* energy range
+* shower core scatter radius
+* view cone radius
+* total number of events to be simulated
+
+Configuration parameters depend on characteristics of the observations, especially elevation,
+azimuth, and night sky background.
+
+The configuration parameters are derived according to the required precision. The metrics are:
+
+* statistical uncertainty on the determination of the effective area as function of primary energy
+* fraction of lost events to the selected core scatter and view cone radius (to be implemented)
+* statistical uncertainty of the energy migration matrix as function of primary energy
+  (to be implemented)
 
 Command line arguments
 ----------------------
@@ -38,9 +51,9 @@ To run the simulation configuration, execute the script as follows:
         --nsb 0.3 --ctao_data_level "A" --science_case "high_precision" \
         --file_path tests/resources/production_dl2_fits/dl2_mc_events_file.fits \
         --file_type "point-like"    \
-        --metrics_file tests/resources/production_simulation_config_metrics.yaml --site North
+        --metrics_file tests/resources/production_simulation_config_metrics.yml --site North
 
-The output will show the configured simulation parameters.
+The output will show the derived simulation parameters.
 """
 
 import json
@@ -51,6 +64,7 @@ import astropy.units as u
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
+from simtools.data_model import schema
 from simtools.io_operations import io_handler
 from simtools.production_configuration.generate_simulation_config import (
     SimulationConfig,
@@ -60,7 +74,8 @@ from simtools.production_configuration.generate_simulation_config import (
 def _parse(label):
     """Parse command-line arguments."""
     config = configurator.Configurator(
-        label=label, description="Configure and run a simulation based on input parameters."
+        label=label,
+        description="Derive simulation configuration parameters for a simulation production.",
     )
     config.parser.add_argument(
         "--azimuth", type=float, required=True, help="Azimuth angle in degrees."
@@ -128,6 +143,9 @@ def main():
     metrics = (
         gen.collect_data_from_file(args_dict["metrics_file"]) if "metrics_file" in args_dict else {}
     )
+    schema.validate_dict_using_schema(
+        data=metrics, schema_file="production_configuration_metrics.schema.yml"
+    )
 
     simulation_config = SimulationConfig(
         grid_point=grid_point_config,

simtools/applications/production_scale_events.py

@@ -36,7 +36,6 @@ The output will display the scaled events for the specified grid point.
 
 import json
 import logging
-import os
 from pathlib import Path
 
 import astropy.units as u
@@ -94,8 +93,8 @@ def _parse(label, description):
     config.parser.add_argument(
         "--metrics_file",
         type=str,
-        default="production_simulation_config_metrics.yaml",
-        help="Metrics definition file. (default: production_simulation_config_metrics.yaml)",
+        default="production_simulation_config_metrics.yml",
+        help="Metrics definition file. (default: production_simulation_config_metrics.yml)",
     )
     config.parser.add_argument(
         "--science_case", type=str, required=True, help="Science case for the simulation."
@@ -129,7 +128,7 @@ def main():
                 # Build file path based on base_path, zenith, and offset
                 file_name = f"prod6_LaPalma-{int(zenith.value)}deg_"
                 file_name += "gamma_cone.N.Am-4LSTs09MSTs_ID0_reduced.fits"
-                file_path = os.path.join(args_dict["base_path"], file_name)
+                file_path = Path(args_dict["base_path"]).joinpath(file_name)
 
                 evaluator = StatisticalErrorEvaluator(
                     file_path,

simtools/applications/simulate_light_emission.py

@@ -1,6 +1,6 @@
 #!/usr/bin/python3
 
-"""
+r"""
     Simulate calibration devices using the light emission package.
 
     Run the application in the command line.
@@ -235,7 +235,7 @@ def _parse(label):
     )
     return config.initialize(
         db_config=True,
-        simulation_model="telescope",
+        simulation_model=["telescope", "model_version"],
         require_command_line=True,
     )