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

{gammasimtools-0.15.0.dist-info → gammasimtools-0.16.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{gammasimtools-0.15.0.dist-info → gammasimtools-0.16.0.dist-info}/entry_points.txt

@@ -15,19 +15,22 @@ simtools-derive-mirror-rnda = simtools.applications.derive_mirror_rnda:main
 simtools-derive-photon-electron-spectrum = simtools.applications.derive_photon_electron_spectrum:main
 simtools-derive-psf-parameters = simtools.applications.derive_psf_parameters:main
 simtools-docs-produce-array-element-report = simtools.applications.docs_produce_array_element_report:main
+simtools-docs-produce-calibration-reports = simtools.applications.docs_produce_calibration_reports:main
 simtools-docs-produce-model-parameter-reports = simtools.applications.docs_produce_model_parameter_reports:main
+simtools-docs-produce-simulation-configuration-report = simtools.applications.docs_produce_simulation_configuration_report:main
 simtools-generate-array-config = simtools.applications.generate_array_config:main
 simtools-generate-corsika-histograms = simtools.applications.generate_corsika_histograms:main
 simtools-generate-default-metadata = simtools.applications.generate_default_metadata:main
 simtools-generate-regular-arrays = simtools.applications.generate_regular_arrays:main
-simtools-generate-simtel-array-histograms = simtools.applications.generate_simtel_array_histograms:main
+simtools-generate-sim-telarray-histograms = simtools.applications.generate_sim_telarray_histograms:main
 simtools-generate-simtel-event-data = simtools.applications.generate_simtel_event_data:main
 simtools-plot-array-layout = simtools.applications.plot_array_layout:main
 simtools-plot-tabular-data = simtools.applications.plot_tabular_data:main
 simtools-print-version = simtools.applications.print_version:main
 simtools-production-derive-corsika-limits = simtools.applications.production_derive_corsika_limits:main
+simtools-production-derive-statistics = simtools.applications.production_derive_statistics:main
+simtools-production-generate-grid = simtools.applications.production_generate_grid:main
 simtools-production-generate-simulation-config = simtools.applications.production_generate_simulation_config:main
-simtools-production-scale-events = simtools.applications.production_scale_events:main
 simtools-run-application = simtools.applications.run_application:main
 simtools-simulate-light-emission = simtools.applications.simulate_light_emission:main
 simtools-simulate-prod = simtools.applications.simulate_prod:main

simtools/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.15.0'
-__version_tuple__ = version_tuple = (0, 15, 0)
+__version__ = version = '0.16.0'
+__version_tuple__ = version_tuple = (0, 16, 0)

simtools/applications/calculate_trigger_rate.py

@@ -3,14 +3,14 @@
 r"""
 Calculates array or single-telescope trigger rates.
 
-The applications reads from a simtel_array output file, a list of
-simtel_array output files ou from a file containing a list of simtel_array files.
+The applications reads from a sim_telarray output file, a list of
+sim_telarray output files ou from a file containing a list of sim_telarray files.
 
 
 Command line arguments
 ----------------------
 simtel_file_names (str or list):
-    Path to the simtel_array file or a list of simtel_array output files.
+    Path to the sim_telarray file or a list of sim_telarray output files.
     Files can be generated in `simulate_prod` using the ``--save_file_lists`` option.
 save_tables (bool):
     If true, save the tables with the energy-dependent trigger rate to a ecsv file.
@@ -28,7 +28,7 @@ area_from_distribution (bool):
 
 Example
 -------
-Calculate trigger rate from simtel_array file
+Calculate trigger rate from sim_telarray file
 
 .. code-block:: console
 
@@ -73,8 +73,8 @@ def _parse(label, description):
 
     config.parser.add_argument(
         "--simtel_file_names",
-        help="Name of the simtel_array output files to be calculate the trigger rate from or the "
-        "text file containing the list of simtel_array output files.",
+        help="Name of the sim_telarray output files to be calculate the trigger rate from or the "
+        "text file containing the list of sim_telarray output files.",
         nargs="+",
         required=True,
         type=str,
@@ -136,20 +136,20 @@ def _get_simulation_parameters(config_parser):
 def main():  # noqa: D103
     label = Path(__file__).stem
     description = (
-        "Calculates the simulated and triggered event rate based on simtel_array output files."
+        "Calculates the simulated and triggered event rate based on sim_telarray output files."
     )
     config_parser = _parse(label, description)
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(config_parser["log_level"]))
 
-    simtel_array_files = gen.get_list_of_files_from_command_line(
+    sim_telarray_files = gen.get_list_of_files_from_command_line(
         config_parser["simtel_file_names"], [".zst", ".simtel", ".hdata"]
     )
     energy_range, view_cone = _get_simulation_parameters(config_parser)
 
     histograms = SimtelIOHistograms(
-        simtel_array_files,
+        sim_telarray_files,
         area_from_distribution=config_parser["area_from_distribution"],
         energy_range=energy_range,
         view_cone=view_cone,
@@ -177,7 +177,7 @@ def main():  # noqa: D103
         output_path = io_handler_instance.get_output_directory(label, sub_dir="application-plots")
         for i_table, table in enumerate(trigger_rate_in_tables):
             output_file = (
-                str(output_path.joinpath(Path(simtel_array_files[i_table]).stem)) + ".ecsv"
+                str(output_path.joinpath(Path(sim_telarray_files[i_table]).stem)) + ".ecsv"
             )
             logger.info(f"Writing table {i_table + 1} to {output_file}")
             table.write(output_file, overwrite=True)

simtools/applications/convert_all_model_parameters_from_simtel.py

@@ -4,7 +4,7 @@ r"""
 
     Check value, type, and range, convert units using schema files. Write json files
     ready to be submitted to the model database. Prints out parameters which are not found
-    in simtel configuration file and parameters which are not found in simtools schema files.
+    in sim_telarray configuration file and parameters which are not found in simtools schema files.
 
     Note that all parameters are assigned the same parameter version.
 
@@ -44,7 +44,7 @@ r"""
             2>|/dev/null | grep '(@cfg)' | sed 's/^(@cfg) //' >| all_telescope_config_paranal.cfg
 
 
-    Extract then model parameters from the simtel_array configuration file for LSTN-01
+    Extract then model parameters from the sim_telarray configuration file for LSTN-01
     (telescopes are named CT1, CT2, ..., in the sim_telarray configuration file and must be
     provided in the "simtel_telescope_name" command line argument)
     and write json files in the same format as the model parameter database:
@@ -94,7 +94,7 @@ def _parse(label=None, description=None):
 
     config.parser.add_argument(
         "--simtel_cfg_file",
-        help="File name for simtel_array configuration",
+        help="File name for sim_telarray configuration",
         type=str,
         required=True,
     )
@@ -116,7 +116,7 @@ def _parse(label=None, description=None):
 
 def read_simtel_config_file(args_dict, schema_file, camera_pixels=None):
     """
-    Read the simtel configuration file.
+    Read the sim_telarray configuration file.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def read_simtel_config_file(args_dict, schema_file, camera_pixels=None):
 
 def get_number_of_camera_pixel(args_dict, logger):
     """
-    Get the number of camera pixels from the simtel configuration file.
+    Get the number of camera pixels from the sim_telarray configuration file.
 
     Required to set the dimension some of the parameter correctly, as simtel
     in some cases does not provide the dimension ('all:' in the parameter files).
@@ -178,7 +178,7 @@ def get_number_of_camera_pixel(args_dict, logger):
 
 def read_and_export_parameters(args_dict, logger):
     """
-    Read and export parameters from simtel configuration file to json files.
+    Read and export parameters from sim_telarray configuration file to json files.
 
     Provide extensive logging information on the parameters found in the simtel
     configuration file.
@@ -193,16 +193,16 @@ def read_and_export_parameters(args_dict, logger):
     Returns
     -------
     list
-        List of simtel parameters not found in schema files.
+        List of sim_telarray parameters not found in schema files.
     list
-        List of simtools parameter not found in simtel configuration file.
+        List of simtools parameter not found in sim_telarray configuration file.
 
     """
-    _parameters, _schema_files = schema.get_get_model_parameter_schema_files()
+    _parameters, _schema_files = schema.get_model_parameter_schema_files()
     _simtel_parameters = simtel_config_reader.get_list_of_simtel_parameters(
         args_dict["simtel_cfg_file"]
     )
-    logger.info(f"Found {len(_simtel_parameters)} parameters in simtel configuration file.")
+    logger.info(f"Found {len(_simtel_parameters)} parameters in sim_telarray configuration file.")
 
     io_handler = IOHandler()
     io_handler.set_paths(output_path=args_dict["output_path"])
@@ -223,7 +223,7 @@ def read_and_export_parameters(args_dict, logger):
             _parameters_not_in_simtel.append(_parameter)
             continue
 
-        logger.info(f"Simtel parameter: {config_reader.parameter_dict}")
+        logger.info(f"sim_telarray parameter: {config_reader.parameter_dict}")
 
         _json_dict = writer.ModelDataWriter.dump_model_parameter(
             parameter_name=_parameter,
@@ -252,15 +252,15 @@ def print_parameters_not_found(_parameters_not_in_simtel, _simtel_parameters, ar
     """
     Print simtel/simtools parameter not found in schema and configuration files.
 
-    For simtel parameters not found, check if the setting for the chose
+    For sim_telarray parameters not found, check if the setting for the chose
     telescope is different from the default values.
 
     Parameters
     ----------
     _parameters_not_in_simtel: list
-        List of simtel parameters not found in schema files.
+        List of sim_telarray parameters not found in schema files.
     _simtel_parameters: list
-        List of simtel parameters not found in simtools schema files.
+        List of sim_telarray parameters not found in simtools schema files.
     args_dict: dict
         Dictionary with command line arguments.
     logger: logging.Logger
@@ -273,9 +273,9 @@ def print_parameters_not_found(_parameters_not_in_simtel, _simtel_parameters, ar
     for para in sorted(_parameters_not_in_simtel):
         logger.info(f"  {para}")
 
-    logger.info(f"Simtel parameters not found in schema files ({len(_simtel_parameters)}):")
+    logger.info(f"sim_telarray parameters not found in schema files ({len(_simtel_parameters)}):")
     for para in sorted(_simtel_parameters):
-        logger.info(f"Simtel parameter: {para}")
+        logger.info(f"sim_telarray parameter: {para}")
         config_reader = simtel_config_reader.SimtelConfigReader(
             schema_file=None,
             simtel_config_file=args_dict["simtel_cfg_file"],

simtools/applications/convert_model_parameter_from_simtel.py

@@ -68,7 +68,7 @@ def _parse(label=None, description=None):
     )
     config.parser.add_argument(
         "--simtel_cfg_file",
-        help="File name for simtel_array configuration",
+        help="File name for sim_telarray configuration",
         type=str,
         required=True,
     )

simtools/applications/derive_psf_parameters.py

@@ -93,7 +93,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.model.telescope_model import TelescopeModel
+from simtools.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize
 
@@ -304,7 +304,7 @@ def calculate_rmsd(data, sim):
     return np.sqrt(np.mean((data - sim) ** 2))
 
 
-def run_pars(tel_model, args_dict, pars, data_to_plot, radius, pdf_pages):
+def run_pars(tel_model, site_model, args_dict, pars, data_to_plot, radius, pdf_pages):
     """
     Run the tuning for one set of parameters, add a plot to the pdfPages and return RMSD and D80.
 
@@ -319,6 +319,7 @@ def run_pars(tel_model, args_dict, pars, data_to_plot, radius, pdf_pages):
 
     ray = RayTracing(
         telescope_model=tel_model,
+        site_model=site_model,
         simtel_path=args_dict["simtel_path"],
         zenith_angle=args_dict["zenith"] * u.deg,
         source_distance=args_dict["src_distance"] * u.km,
@@ -370,7 +371,9 @@ def run_pars(tel_model, args_dict, pars, data_to_plot, radius, pdf_pages):
     return d80, rmsd
 
 
-def find_best_parameters(all_parameters, tel_model, args_dict, data_to_plot, radius, pdf_pages):
+def find_best_parameters(
+    all_parameters, tel_model, site_model, args_dict, data_to_plot, radius, pdf_pages
+):
     """
     Find the best parameters from all parameter sets.
 
@@ -382,7 +385,7 @@ def find_best_parameters(all_parameters, tel_model, args_dict, data_to_plot, rad
     best_pars = None
 
     for pars in all_parameters:
-        _, rmsd = run_pars(tel_model, args_dict, pars, data_to_plot, radius, pdf_pages)
+        _, rmsd = run_pars(tel_model, site_model, args_dict, pars, data_to_plot, radius, pdf_pages)
         if rmsd < min_rmsd:
             min_rmsd = rmsd
             best_pars = pars
@@ -400,12 +403,12 @@ def main():  # noqa: D103
     # Output directory to save files related directly to this app
     _io_handler = io_handler.IOHandler()
     output_dir = _io_handler.get_output_directory(label, sub_dir="application-plots")
-    tel_model = TelescopeModel(
+    tel_model, site_model = initialize_simulation_models(
+        label=label,
+        db_config=db_config,
         site=args_dict["site"],
         telescope_name=args_dict["telescope"],
-        mongo_db_config=db_config,
         model_version=args_dict["model_version"],
-        label=label,
     )
 
     all_parameters = []
@@ -424,11 +427,11 @@ def main():  # noqa: D103
     pdf_pages = PdfPages(plot_file)
 
     best_pars, _ = find_best_parameters(
-        all_parameters, tel_model, args_dict, data_to_plot, radius, pdf_pages
+        all_parameters, tel_model, site_model, args_dict, data_to_plot, radius, pdf_pages
     )
 
     # Rerunning and plotting the best pars
-    run_pars(tel_model, args_dict, best_pars, data_to_plot, radius, pdf_pages)
+    run_pars(tel_model, site_model, args_dict, best_pars, data_to_plot, radius, pdf_pages)
     plt.close()
     pdf_pages.close()
 

simtools/applications/docs_produce_array_element_report.py

@@ -5,7 +5,6 @@ Produces a markdown file for a given array element, site, and model version.
 
 The report includes detailed information on each parameter,
 such as the parameter name, value, unit, description, and short description.
-Currently only implemented for telescopes.
 """
 
 import logging
@@ -70,15 +69,16 @@ def main():  # noqa: D103
         ).auto_generate_array_element_reports()
 
     else:
+        model_version = args["model_version"]
         ReadParameters(
             db_config,
             args,
-            Path(output_path / f"{args['model_version']}"),
+            Path(output_path / f"{model_version}"),
         ).produce_array_element_report()
 
         logger.info(
             f"Markdown report generated for {args['site']}"
-            f" Telescope {args['telescope']} (v{args['model_version']}):"
+            f" Telescope {args['telescope']} (v{model_version}):"
             f" {output_path}"
         )
 

simtools/applications/docs_produce_calibration_reports.py

@@ -0,0 +1,49 @@
+#!/usr/bin/python3
+
+r"""Produces a markdown file for calibration reports."""
+
+import logging
+
+from simtools.configuration import configurator
+from simtools.io_operations import io_handler
+from simtools.reporting.docs_read_parameters import ReadParameters
+from simtools.utils import general as gen
+
+
+def _parse(label):
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=label,
+        description=("Produce a markdown report for calibration parameters."),
+    )
+
+    return config.initialize(
+        db_config=True,
+        simulation_model=["model_version"],
+    )
+
+
+def main():  # noqa: D103
+    label_name = "reports"
+    args, db_config = _parse(label_name)
+
+    io_handler_instance = io_handler.IOHandler()
+    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="productions")
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args["log_level"]))
+
+    read_parameters = ReadParameters(
+        db_config=db_config, args=args, output_path=output_path / f"{args.get('model_version')}"
+    )
+
+    read_parameters.produce_calibration_reports()
+
+    logger.info(
+        f"Calibation reports for model version {args.get('model_version')} produced successfully."
+    )
+    logger.info(f"Output path: {output_path}/{args.get('model_version')}/")
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/docs_produce_simulation_configuration_report.py

@@ -0,0 +1,50 @@
+#!/usr/bin/python3
+
+r"""Produces a markdown file for a given simulation configuration."""
+
+import logging
+
+from simtools.configuration import configurator
+from simtools.io_operations import io_handler
+from simtools.reporting.docs_read_parameters import ReadParameters
+from simtools.utils import general as gen
+
+
+def _parse(label):
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=label,
+        description=("Produce a markdown report for model parameters."),
+    )
+
+    return config.initialize(
+        db_config=True,
+        simulation_model=["model_version"],
+        simulation_configuration=["software"],
+    )
+
+
+def main():  # noqa: D103
+    label_name = "reports"
+    args, db_config = _parse(label_name)
+
+    io_handler_instance = io_handler.IOHandler()
+    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="productions")
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args["log_level"]))
+
+    read_parameters = ReadParameters(
+        db_config=db_config, args=args, output_path=output_path / f"{args.get('model_version')}"
+    )
+
+    read_parameters.produce_simulation_configuration_report()
+
+    logger.info(
+        f"Configuration reports for {args.get('simulation_software')} produced successfully."
+    )
+    logger.info(f"Output path: {output_path}/{args.get('model_version')}/")
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/{generate_simtel_array_histograms.py → generate_sim_telarray_histograms.py}

@@ -39,7 +39,7 @@ r"""
     -------
     .. code-block:: console
 
-        simtools-generate-simtel-array-histograms --hist_file_names tests/resources/ \\
+        simtools-generate-sim-telarray-histograms --hist_file_names tests/resources/ \\
             run2_gamma_za20deg_azm0deg-North-Prod5_test-production-5.hdata.zst \\
             --output_file_name test_hist_hdata --hdf5 --pdf
 
@@ -167,7 +167,7 @@ def create_pdf(simtel_histograms, output_file_name, config_parser, logger):
 
 def main():  # noqa: D103
     label = Path(__file__).stem
-    description = "Display simtel_array histograms and/or write them into hdf5 format."
+    description = "Display sim_telarray 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")

simtools/applications/production_derive_corsika_limits.py

@@ -34,7 +34,9 @@ Derive limits for a given file with a specified loss fraction.
 
 import datetime
 import logging
+import re
 
+import numpy as np
 from astropy.table import Table
 
 import simtools.utils.general as gen
@@ -122,8 +124,37 @@ def process_file(file_path, telescope_ids, loss_fraction, plot_histograms):
     Returns
     -------
     dict
-        Dictionary containing the computed limits.
+        Dictionary containing the computed limits and metadata.
     """
+    # Extract zenith and azimuth from the file path
+    match = re.search(r"za(\d+)deg.*azm(\d+)deg", file_path)
+    if not match:
+        raise ValueError(f"Could not extract zenith and azimuth from file path: {file_path}")
+    zenith = int(match.group(1))
+    azimuth = int(match.group(2))
+
+    if "dark" in file_path:
+        nsb = 1
+    elif "halfmoon" in file_path:
+        nsb = 5
+    elif "moon" in file_path:
+        nsb = 19
+    else:
+        _logger.warning(f"Could not determine NSB from file path: {file_path}")
+        nsb = None
+
+    if "gamma-diffuse" in file_path:
+        particle_type = "gamma-diffuse"
+    elif "gamma" in file_path:
+        particle_type = "gamma"
+    elif "proton" in file_path:
+        particle_type = "proton"
+    elif "electron" in file_path:
+        particle_type = "electron"
+    else:
+        _logger.warning(f"Could not determine particle type from file path: {file_path}")
+        particle_type = "unknown"
+
     calculator = LimitCalculator(file_path, telescope_list=telescope_ids)
 
     lower_energy_limit = calculator.compute_lower_energy_limit(loss_fraction)
@@ -142,8 +173,11 @@ def process_file(file_path, telescope_ids, loss_fraction, plot_histograms):
         )
 
     return {
-        "file_path": file_path,
+        "particle_type": particle_type,
         "telescope_ids": telescope_ids,
+        "zenith": zenith,
+        "azimuth": azimuth,
+        "nsb": nsb,
         "lower_energy_threshold": lower_energy_limit,
         "upper_radius_threshold": upper_radial_distance,
         "viewcone_radius": viewcone,
@@ -158,7 +192,7 @@ def create_results_table(results, loss_fraction):
     ----------
     results : list[dict]
         List of dictionaries containing the computed limits for each file
-          and telescope configuration.
+        and telescope configuration.
     loss_fraction : float
         Fraction of events to be lost, added as metadata to the table.
 
@@ -167,33 +201,52 @@ def create_results_table(results, loss_fraction):
     astropy.table.Table
         An Astropy Table containing the results with appropriate units and metadata.
     """
+    print("results", results)
     table = Table(
         rows=[
             (
-                res["file_path"],
+                res["particle_type"],
                 res["telescope_ids"],
-                res["lower_energy_threshold"],
-                res["upper_radius_threshold"],
-                res["viewcone_radius"],
+                res["zenith"],
+                res["azimuth"],
+                res["nsb"],
+                res["lower_energy_threshold"].value,
+                res["upper_radius_threshold"].value,
+                res["viewcone_radius"].value,
             )
             for res in results
         ],
         names=[
-            "file_path",
+            "particle_type",
             "telescope_ids",
+            "zenith",
+            "azimuth",
+            "nsb",
             "lower_energy_threshold",
             "upper_radius_threshold",
             "viewcone_radius",
         ],
+        dtype=[
+            "S64",
+            object,
+            np.float64,
+            np.float64,
+            object,
+            np.float64,
+            np.float64,
+            np.float64,
+        ],
     )
-
+    table["zenith"].unit = "deg"
+    table["azimuth"].unit = "deg"
     table["lower_energy_threshold"].unit = "TeV"
     table["upper_radius_threshold"].unit = "m"
     table["viewcone_radius"].unit = "deg"
 
     table.meta["created"] = datetime.datetime.now().isoformat()
     table.meta["description"] = (
-        "Lookup table for CORSIKA limits computed from gamma-ray shower simulations."
+        "Lookup table for CORSIKA limits computed from gamma-ray shower simulations "
+        "using simtool production_derive_corsika_limits"
     )
     table.meta["loss_fraction"] = loss_fraction