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

{gammasimtools-0.13.0.dist-info → gammasimtools-0.14.0.dist-info}/WHEEL

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

{gammasimtools-0.13.0.dist-info → gammasimtools-0.14.0.dist-info}/entry_points.txt

@@ -10,6 +10,7 @@ simtools-db-get-array-layouts-from-db = simtools.applications.db_get_array_layou
 simtools-db-get-file-from-db = simtools.applications.db_get_file_from_db:main
 simtools-db-get-parameter-from-db = simtools.applications.db_get_parameter_from_db:main
 simtools-db-inspect-databases = simtools.applications.db_inspect_databases:main
+simtools-derive-ctao-array-layouts = simtools.applications.derive_ctao_array_layouts:main
 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
@@ -20,10 +21,11 @@ simtools-generate-corsika-histograms = simtools.applications.generate_corsika_hi
 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-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-extract-mc-event-data = simtools.applications.production_extract_mc_event_data: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/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.13.0'
-__version_tuple__ = version_tuple = (0, 13, 0)
+__version__ = version = '0.14.0'
+__version_tuple__ = version_tuple = (0, 14, 0)

simtools/applications/db_add_file_to_db.py

@@ -38,6 +38,7 @@
 """
 
 import logging
+import uuid
 from pathlib import Path
 
 import simtools.utils.general as gen
@@ -69,6 +70,11 @@ def _parse():
         type=str,
         help=("The database to insert the files to."),
     )
+    config.parser.add_argument(
+        "--test_db",
+        help="Use sandbox database. Drop all data after the operation.",
+        action="store_true",
+    )
 
     return config.initialize(paths=False, db_config=True)
 
@@ -134,6 +140,10 @@ def confirm_and_insert_files(files_to_insert, args_dict, db, logger):
     """
     plural = "" if len(files_to_insert) == 1 else "s"
 
+    if args_dict.get("test_db", False):
+        args_dict["db"] = args_dict["db"] + str(uuid.uuid4())
+        logger.info(f"Using test database: {args_dict['db']}")
+
     print(f"Should the following file{plural} be inserted to the {args_dict['db']} DB?:\n")
     print(*files_to_insert, sep="\n")
     print()
@@ -145,6 +155,11 @@ def confirm_and_insert_files(files_to_insert, args_dict, db, logger):
     else:
         logger.info(f"Aborted, did not insert file{plural} to the {args_dict['db']} DB")
 
+    # drop test database; be safe and required DB name is sandbox
+    if args_dict.get("test_db", False) and "sandbox" in args_dict["db"]:
+        logger.info(f"Test database used. Dropping all data from {args_dict['db']}")
+        db.db_client.drop_database(args_dict["db"])
+
 
 def main():  # noqa: D103
     args_dict, db_config = _parse()

simtools/applications/db_add_value_from_json_to_db.py

@@ -26,6 +26,7 @@ r"""
 """
 
 import logging
+import uuid
 from pathlib import Path
 
 import simtools.utils.general as gen
@@ -45,7 +46,11 @@ def _parse():
     config.parser.add_argument(
         "--db_collection", help="DB collection to which to add new values.", required=True
     )
-    config.parser.add_argument("--db", help="Database name", type=str, required=True)
+    config.parser.add_argument(
+        "--test_db",
+        help="Use sandbox database. Drop all data after the operation.",
+        action="store_true",
+    )
     return config.initialize(db_config=True)
 
 
@@ -55,6 +60,9 @@ def main():  # noqa: D103
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
+    if args_dict.get("test_db", False):
+        db_config["db_simulation_model"] = db_config["db_simulation_model"] + str(uuid.uuid4())
+        logger.info(f"Using test database: {db_config['db_simulation_model']}")
     db = db_handler.DatabaseHandler(mongo_db_config=db_config)
 
     files_to_insert = []
@@ -74,6 +82,8 @@ def main():  # noqa: D103
     print(*files_to_insert, sep="\n")
     print()
 
+    logger.info(f"DB {args_dict['db_simulation_model']} selected.")
+
     if gen.user_confirm():
         for file_to_insert_now in files_to_insert:
             par_dict = gen.collect_data_from_file(file_name=file_to_insert_now)
@@ -91,6 +101,13 @@ def main():  # noqa: D103
     else:
         logger.info("Aborted, no change applied to the database")
 
+    # drop test database; be safe and required DB name is sandbox
+    if args_dict.get("test_db", False) and "sandbox" in args_dict["db_simulation_model"]:
+        logger.info(
+            f"Test database used. Dropping all data from {db_config['db_simulation_model']}"
+        )
+        db.db_client.drop_database(db_config["db_simulation_model"])
+
 
 if __name__ == "__main__":
     main()

simtools/applications/derive_ctao_array_layouts.py

@@ -0,0 +1,120 @@
+#!/usr/bin/python3
+
+r"""
+    Derive CTAO array layouts definitions using CTAO common identifiers repository.
+
+    Retrieves the CTAO array layouts definitions from the CTAO common identifiers repository
+    and synchronizes them with the model parameter definition in 'array_layouts' for all
+    CTAO sites.
+
+    Requires access to the CTAO common identifiers repository. Future versions of the
+    common identifiers might be stored in a CTAO technical database.
+
+    Command line arguments
+    ----------------------
+    site (str)
+        CTAO site (North or South).
+    parameter_version (str)
+        Model parameter version.
+    repository_url (str)
+        URL or path of the CTAO common identifiers repository.
+    repository_branch (str )
+        Repository branch to use for CTAO common identifiers.
+    updated_parameter_version (str)
+        Updated parameter version.
+
+    Example
+    -------
+
+    Derive the CTAO array layouts definitions for the North site using the CTAO common identifiers
+    repository. Merge the retrieved array layouts with the model parameter definition in
+    'array_layouts' (in this example for site North and parameter version 2.0.0). Write the
+    updated array layouts and metadata using the parameter version indicated by the
+    'updated_parameter_version' argument.
+
+    .. code-block:: console
+
+        simtools-derive-ctao-array-layouts --site North \
+            --repository_url "https://gitlab.cta-observatory.org/" \
+            "cta-computing/common/identifiers/-/raw/" \
+            --repository_branch main \
+            --site North --parameter_version 2.0.0 \
+            --updated_parameter_version 3.0.0
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.db import db_handler
+from simtools.layout.ctao_array_layouts import (
+    merge_array_layouts,
+    retrieve_array_layouts,
+    write_array_layouts,
+)
+
+
+def _parse(label):
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=label,
+        description="Derive CTAO array layouts from CTAO common identifiers repository.",
+    )
+    config.parser.add_argument(
+        "--repository_url",
+        help="URL or path of the CTAO common identifiers repository.",
+        type=str,
+        default="https://gitlab.cta-observatory.org/cta-computing/common/identifiers/-/raw/",
+    )
+    config.parser.add_argument(
+        "--repository_branch",
+        help="Repository branch to use for CTAO common identifiers.",
+        type=str,
+        default="main",
+        required=False,
+    )
+    config.parser.add_argument(
+        "--updated_parameter_version",
+        help="Updated parameter version.",
+        type=str,
+        required=False,
+    )
+    return config.initialize(
+        db_config=True, output=True, simulation_model=["site", "parameter_version", "model_version"]
+    )
+
+
+def main():  # noqa: D103
+    args_dict, db_config = _parse(Path(__file__).stem)
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    ctao_array_layouts = retrieve_array_layouts(
+        site=args_dict["site"],
+        repository_url=args_dict["repository_url"],
+        branch_name=args_dict["repository_branch"],
+    )
+
+    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db_array_layouts = db.get_model_parameter(
+        parameter="array_layouts",
+        site=args_dict["site"],
+        array_element_name=None,
+        parameter_version=args_dict.get("parameter_version"),
+        model_version=args_dict.get("model_version"),
+    )
+    db_array_layouts["array_layouts"].pop("_id", None)
+    db_array_layouts["array_layouts"].pop("entry_date", None)
+    logger.info(f"Layouts from DB: {db_array_layouts}")
+
+    write_array_layouts(
+        array_layouts=merge_array_layouts(db_array_layouts["array_layouts"], ctao_array_layouts),
+        args_dict=args_dict,
+        db_config=db_config,
+    )
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/derive_photon_electron_spectrum.py

@@ -69,11 +69,39 @@ def _parse(label):
     )
     config.parser.add_argument(
         "--max_amplitude",
-        help="Maximum amplitude in amplitude spectrum",
+        help="Maximum amplitude for single p.e. for amplitude spectrum",
         type=float,
         default=42.0,
         required=False,
     )
+    config.parser.add_argument(
+        "--scale_afterpulse_spectrum",
+        help="Scale afterpulse spectrum by the given factor",
+        type=float,
+        default=1.0,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--afterpulse_amplitude_range",
+        help="Amplitude range in pe for afterpulse calculation",
+        type=float,
+        nargs=2,
+        default=[0.0, 42.0],
+        required=False,
+    )
+    config.parser.add_argument(
+        "--fit_afterpulse",
+        help="Fit afterpulse spectrum with an exponential decay function.",
+        action="store_true",
+        required=False,
+    )
+    config.parser.add_argument(
+        "--afterpulse_decay_factor_fixed_value",
+        help="Fix decay factor in afterpulse fit (free fit parameter if not set set).",
+        type=float,
+        default=15.0,
+        required=False,
+    )
     config.parser.add_argument(
         "--use_norm_spe",
         help="Use sim_telarray tool 'norm_spe' to normalize the spectrum.",

simtools/applications/docs_produce_array_element_report.py

@@ -9,9 +9,11 @@ Currently only implemented for telescopes.
 """
 
 import logging
+from pathlib import Path
 
 from simtools.configuration import configurator
 from simtools.io_operations import io_handler
+from simtools.reporting.docs_auto_report_generator import ReportGenerator
 from simtools.reporting.docs_read_parameters import ReadParameters
 from simtools.utils import general as gen
 
@@ -24,38 +26,61 @@ def _parse(label):
     )
 
     config.parser.add_argument(
-        "--parameter",
+        "--all_telescopes",
         action="store_true",
-        help="Compare all parameters across model versions for one telescope.",
+        help="Produce reports for all telescopes.",
+    )
+
+    config.parser.add_argument(
+        "--all_model_versions",
+        action="store_true",
+        help="Produce reports for all model versions.",
+    )
+
+    config.parser.add_argument(
+        "--all_sites", action="store_true", help="Produce reports for all sites."
+    )
+
+    config.parser.add_argument(
+        "--observatory",
+        action="store_true",
+        help="Produce reports for an observatory at a given site.",
     )
 
     return config.initialize(
-        db_config=True, simulation_model=["site", "telescope", "model_version", "parameter_version"]
+        db_config=True, simulation_model=["site", "telescope", "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=f"productions/{args['model_version']}"
-    )
+    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"]))
 
-    ReadParameters(
-        db_config,
-        args,
-        output_path,
-    ).produce_array_element_report()
+    if any([args.get("all_telescopes"), args.get("all_sites"), args.get("all_model_versions")]):
+        ReportGenerator(
+            db_config,
+            args,
+            output_path,
+        ).auto_generate_array_element_reports()
 
-    logger.info(
-        f"Markdown report generated for {args['site']}"
-        f" Telescope {args['telescope']} (v{args['model_version']}):"
-        f" {output_path}"
-    )
+    else:
+        ReadParameters(
+            db_config,
+            args,
+            Path(output_path / f"{args['model_version']}"),
+        ).produce_array_element_report()
+
+        logger.info(
+            f"Markdown report generated for {args['site']}"
+            f" Telescope {args['telescope']} (v{args['model_version']}):"
+            f" {output_path}"
+        )
 
 
 if __name__ == "__main__":

simtools/applications/docs_produce_model_parameter_reports.py

@@ -12,6 +12,7 @@ import logging
 
 from simtools.configuration import configurator
 from simtools.io_operations import io_handler
+from simtools.reporting.docs_auto_report_generator import ReportGenerator
 from simtools.reporting.docs_read_parameters import ReadParameters
 from simtools.utils import general as gen
 
@@ -23,6 +24,16 @@ def _parse(label):
         description=("Produce a markdown report for model parameters."),
     )
 
+    config.parser.add_argument(
+        "--all_telescopes",
+        action="store_true",
+        help="Produce reports for all telescopes.",
+    )
+
+    config.parser.add_argument(
+        "--all_sites", action="store_true", help="Produce reports for all sites."
+    )
+
     return config.initialize(db_config=True, simulation_model=["site", "telescope"])
 
 
@@ -35,15 +46,24 @@ def main():  # noqa: D103
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args["log_level"]))
 
-    ReadParameters(
-        db_config,
-        args,
-        output_path,
-    ).produce_model_parameter_reports()
+    if any([args.get("all_telescopes"), args.get("all_sites")]):
+        ReportGenerator(
+            db_config,
+            args,
+            output_path,
+        ).auto_generate_parameter_reports()
 
-    logger.info(
-        f"Markdown report generated for {args['site']} Telescope {args['telescope']}: {output_path}"
-    )
+    else:
+        ReadParameters(
+            db_config,
+            args,
+            output_path,
+        ).produce_model_parameter_reports()
+
+        logger.info(
+            f"Markdown report generated for {args['site']}"
+            f"Telescope {args['telescope']}: {output_path}"
+        )
 
 
 if __name__ == "__main__":

simtools/applications/{production_extract_mc_event_data.py → generate_simtel_event_data.py}

@@ -21,6 +21,7 @@ Generate a reduced dataset from input files and save the result.
 .. code-block:: console
 
     simtools-production-extract-mc-event-data \
+    simtools-generate-simtel-event-data \
         --prefix path/to/input_files/ \
         --wildcard 'gamma_*dark*.simtel.zst' \
         --output_file output_file.hdf5 \
@@ -34,7 +35,8 @@ from pathlib import Path
 import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.io_operations import io_handler
-from simtools.production_configuration.extract_mc_event_data import MCEventExtractor
+from simtools.simtel.simtel_io_event_reader import SimtelIOEventDataReader
+from simtools.simtel.simtel_io_event_writer import SimtelIOEventDataWriter
 
 
 def _parse(label, description):
@@ -64,8 +66,9 @@ def _parse(label, description):
 
     config.parser.add_argument(
         "--print_dataset_information",
-        action="store_true",
-        help="Print information about the datasets in the generated reduced event dataset.",
+        type=int,
+        help="Print given number of rows of the dataset.",
+        default=0,
     )
 
     return config.initialize(db_config=False)
@@ -75,20 +78,7 @@ def main():
     """
     Process event data files and store data in reduced dataset.
 
-    The reduced dataset contains the following information:
-        - simulated: List of simulated events.
-        - shower_id_triggered: List of triggered shower IDs
-            (as in the telescope definition file used for simulations).
-        - triggered_energies: List of energies for triggered events.
-        - num_triggered_telescopes: Number of triggered telescopes for each event.
-        - core_x: X-coordinate of the shower core (ground coordinates).
-        - core_y: Y-coordinate of the shower core (ground coordinates).
-        - trigger_telescope_list_list: List of lists containing triggered telescope IDs.
-        - file_names: List of input file names.
-        - shower_sim_azimuth: Simulated azimuth angle of the shower.
-        - shower_sim_altitude: Simulated altitude angle of the shower.
-        - array_altitudes: List of altitudes for the array.
-        - array_azimuths: List of azimuths for the array.
+    The reduced dataset contains shower information, array information and triggered telescopes.
     """
     label = Path(__file__).stem
 
@@ -114,11 +104,13 @@ def main():
     output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
 
     output_filepath.parent.mkdir(parents=True, exist_ok=True)
-    generator = MCEventExtractor(files, output_filepath, args_dict["max_files"])
+    generator = SimtelIOEventDataWriter(files, output_filepath, args_dict["max_files"])
     generator.process_files()
     _logger.info(f"reduced dataset saved to: {output_filepath}")
-    if args_dict["print_dataset_information"]:
-        generator.print_dataset_information()
+
+    if args_dict["print_dataset_information"] > 0:
+        reader = SimtelIOEventDataReader(output_filepath)
+        reader.print_dataset_information(args_dict.get("print_dataset_information"))
 
 
 if __name__ == "__main__":

simtools/applications/print_version.py

@@ -0,0 +1,81 @@
+#!/usr/bin/python3
+"""
+Print the versions of the simtools software.
+
+The versions of simtools, the DB, sim_telarray, and CORSIKA are printed.
+
+"""
+
+import json
+import logging
+from pathlib import Path
+
+from simtools import dependencies, version
+from simtools.configuration import configurator
+from simtools.io_operations import io_handler
+from simtools.utils import general as gen
+
+
+def _parse(label, description, usage):
+    """
+    Parse command line configuration.
+
+    No command line arguments are required for this application,
+    but the configurator is called to set up the DB connection and
+    the structure with _parse is kept from other applications for consistency.
+
+    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)
+
+    return config.initialize(db_config=True, output=True)
+
+
+def main():
+    """Print the versions of the simtools software."""
+    label = Path(__file__).stem
+    args_dict, db_config = _parse(
+        label=label,
+        description="Print the versions of simtools, the DB, sim_telarray and CORSIKA.",
+        usage="simtools-print-version",
+    )
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    io_handler_instance = io_handler.IOHandler()
+
+    version_string = dependencies.get_version_string(db_config)
+    version_dict = {"simtools version": version.__version__}
+
+    print()
+    # The loop below is not necessary, there is only one entry, but it is cleaner
+    for key, value in version_dict.items():  #
+        print(f"{key}: {value}")
+    print(version_string)
+
+    version_list = version_string.strip().split("\n")
+    for version_entry in version_list:
+        key, value = version_entry.split(": ")
+        version_dict[key] = value
+
+    with open(
+        io_handler_instance.get_output_file(args_dict["output_file"], label=label),
+        "w",
+        encoding="utf-8",
+    ) as f:
+        json.dump(version_dict, f, indent=4)
+
+
+if __name__ == "__main__":
+    main()