gammasimtools 0.22.0__py3-none-any.whl → 0.24.0__py3-none-any.whl

simtools/applications/derive_photon_electron_spectrum.py

@@ -34,18 +34,17 @@ r"""
 
 """
 
-import logging
 from pathlib import Path
 
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.camera.single_photon_electron_spectrum import SinglePhotonElectronSpectrum
 from simtools.configuration import configurator
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description="Derive single photon electron spectrum from a given amplitude spectrum.",
     )
     config.parser.add_argument(
@@ -112,13 +111,11 @@ def _parse(label):
     return config.initialize(db_config=False, output=True, simulation_model=["telescope"])
 
 
-def main():  # noqa: D103
-    args_dict, _ = _parse(Path(__file__).stem)
+def main():
+    """Derive single photon electron spectrum from a given amplitude spectrum."""
+    app_context = startup_application(_parse)
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    single_pe = SinglePhotonElectronSpectrum(args_dict)
+    single_pe = SinglePhotonElectronSpectrum(app_context.args)
     single_pe.derive_single_pe_spectrum()
     single_pe.write_single_pe_spectrum()
 

simtools/applications/derive_psf_parameters.py

@@ -110,22 +110,19 @@ r"""
 
 """
 
-import logging
-from pathlib import Path
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io import io_handler
 from simtools.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing import psf_parameter_optimisation as psf_opt
-from simtools.utils.general import get_log_level_from_user
 
 
 def _parse():
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description=(
             "Derive mirror_reflection_random_angle, mirror_align_random_horizontal "
             "and mirror_align_random_vertical using cumulative PSF measurement."
-        )
+        ),
     )
     config.parser.add_argument(
         "--src_distance",
@@ -196,27 +193,23 @@ def _parse():
     )
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse()
-
-    label = label = Path(__file__).stem
-    logger = logging.getLogger()
-    logger.setLevel(get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Derive PSF parameters."""
+    app_context = startup_application(_parse)
 
-    _io_handler = io_handler.IOHandler()
     tel_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"],
+        label=app_context.args.get("label"),
+        db_config=app_context.db_config,
+        site=app_context.args["site"],
+        telescope_name=app_context.args["telescope"],
+        model_version=app_context.args["model_version"],
     )
 
     psf_opt.run_psf_optimization_workflow(
         tel_model,
         site_model,
-        args_dict,
-        _io_handler.get_output_directory(),
+        app_context.args,
+        app_context.io_handler.get_output_directory(),
     )
 
 

simtools/applications/derive_trigger_rates.py

@@ -37,9 +37,7 @@ Derive trigger rates for the South Alpha layout:
 
 """
 
-import logging
-
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.telescope_trigger_rates import telescope_trigger_rates
 
@@ -47,6 +45,7 @@ from simtools.telescope_trigger_rates import telescope_trigger_rates
 def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description="Derive trigger rates for a single telescope or an array of telescopes.",
     )
     config.parser.add_argument(
@@ -78,13 +77,11 @@ def _parse():
     )
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict.get("log_level", "info")))
+def main():
+    """Derive trigger rates for a single telescope or an array of telescopes."""
+    app_context = startup_application(_parse)
 
-    telescope_trigger_rates(args_dict, db_config)
+    telescope_trigger_rates(app_context.args, app_context.db_config)
 
 
 if __name__ == "__main__":

simtools/applications/docs_produce_array_element_report.py

@@ -7,20 +7,18 @@ The report includes detailed information on each parameter,
 such as the parameter name, value, unit, description, and short description.
 """
 
-import logging
 from pathlib import Path
 
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io 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
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=("Produce a markdown report for model parameters."),
     )
 
@@ -51,34 +49,35 @@ def _parse(label):
     )
 
 
-def main():  # noqa: D103
-    label_name = "reports"
-    args, db_config = _parse(label_name)
+def main():
+    """Produce a markdown file for a given array element, site, and model version."""
+    app_context = startup_application(_parse)
+    output_path = app_context.io_handler.get_output_directory()
 
-    io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args["log_level"]))
-
-    if any([args.get("all_telescopes"), args.get("all_sites"), args.get("all_model_versions")]):
+    if any(
+        [
+            app_context.args.get("all_telescopes"),
+            app_context.args.get("all_sites"),
+            app_context.args.get("all_model_versions"),
+        ]
+    ):
         ReportGenerator(
-            db_config,
-            args,
+            app_context.db_config,
+            app_context.args,
             output_path,
         ).auto_generate_array_element_reports()
 
     else:
-        model_version = args["model_version"]
+        model_version = app_context.args["model_version"]
         ReadParameters(
-            db_config,
-            args,
+            app_context.db_config,
+            app_context.args,
             Path(output_path / f"{model_version}"),
         ).produce_array_element_report()
 
-        logger.info(
-            f"Markdown report generated for {args['site']}"
-            f" Telescope {args['telescope']} (v{model_version}):"
+        app_context.logger.info(
+            f"Markdown report generated for {app_context.args['site']}"
+            f" Telescope {app_context.args['telescope']} (v{model_version}):"
             f" {output_path}"
         )
 

simtools/applications/docs_produce_calibration_reports.py

@@ -2,47 +2,49 @@
 
 r"""Produces a markdown file for calibration reports."""
 
-import logging
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io import io_handler
-from simtools.reporting.docs_read_parameters import ReadParameters
-from simtools.utils import general as gen
+from simtools.reporting.docs_auto_report_generator import ReportGenerator
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=("Produce a markdown report for calibration parameters."),
     )
 
+    config.parser.add_argument(
+        "--all_model_versions",
+        action="store_true",
+        help="Produce reports for all model versions.",
+    )
+
     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()
-
-    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')}"
-    )
+def main():
+    """Produce a markdown file for calibration reports."""
+    app_context = startup_application(_parse)
 
-    read_parameters.produce_calibration_reports()
+    output_path = app_context.io_handler.get_output_directory()
 
-    logger.info(
-        f"Calibation reports for model version {args.get('model_version')} produced successfully."
+    generator = ReportGenerator(
+        db_config=app_context.db_config, args=app_context.args, output_path=output_path
     )
-    logger.info(f"Output path: {output_path}/{args.get('model_version')}/")
+    generator.auto_generate_calibration_reports()
+
+    if app_context.args.get("all_model_versions"):
+        app_context.logger.info("Calibration reports for all model versions produced successfully.")
+    else:
+        app_context.logger.info(
+            f"Calibration reports for model version {app_context.args.get('model_version')}"
+            " produced successfully."
+        )
+    app_context.logger.info(f"Output path: {output_path}")
 
 
 if __name__ == "__main__":

simtools/applications/docs_produce_model_parameter_reports.py

@@ -8,19 +8,16 @@ comparing their values over various model versions.
 Currently only implemented for telescopes.
 """
 
-import logging
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io 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
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=("Produce a markdown report for model parameters."),
     )
 
@@ -37,32 +34,28 @@ def _parse(label):
     return config.initialize(db_config=True, simulation_model=["site", "telescope"])
 
 
-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()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args["log_level"]))
+def main():
+    """Produce a model parameter report per array element."""
+    app_context = startup_application(_parse)
+    output_path = app_context.io_handler.get_output_directory()
 
-    if any([args.get("all_telescopes"), args.get("all_sites")]):
+    if any([app_context.args.get("all_telescopes"), app_context.args.get("all_sites")]):
         ReportGenerator(
-            db_config,
-            args,
+            app_context.db_config,
+            app_context.args,
             output_path,
         ).auto_generate_parameter_reports()
 
     else:
         ReadParameters(
-            db_config,
-            args,
+            app_context.db_config,
+            app_context.args,
             output_path,
         ).produce_model_parameter_reports()
 
-        logger.info(
-            f"Markdown report generated for {args['site']}"
-            f"Telescope {args['telescope']}: {output_path}"
+        app_context.logger.info(
+            f"Markdown report generated for {app_context.args['site']}"
+            f"Telescope {app_context.args['telescope']}: {output_path}"
         )
 
 

simtools/applications/docs_produce_simulation_configuration_report.py

@@ -2,21 +2,24 @@
 
 r"""Produces a markdown file for a given simulation configuration."""
 
-import logging
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io import io_handler
-from simtools.reporting.docs_read_parameters import ReadParameters
-from simtools.utils import general as gen
+from simtools.reporting.docs_auto_report_generator import ReportGenerator
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=("Produce a markdown report for model parameters."),
     )
 
+    config.parser.add_argument(
+        "--all_model_versions",
+        action="store_true",
+        help="Produce reports for all model versions.",
+    )
+
     return config.initialize(
         db_config=True,
         simulation_model=["model_version"],
@@ -24,26 +27,22 @@ def _parse(label):
     )
 
 
-def main():  # noqa: D103
-    label_name = "reports"
-    args, db_config = _parse(label_name)
+def main():
+    """Produce a markdown file for a given simulation configuration."""
+    app_context = startup_application(_parse)
 
-    io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory()
+    output_path = app_context.io_handler.get_output_directory()
 
-    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')}"
+    report_generator = ReportGenerator(
+        db_config=app_context.db_config, args=app_context.args, output_path=output_path
     )
+    report_generator.auto_generate_simulation_configuration_reports()
 
-    read_parameters.produce_simulation_configuration_report()
-
-    logger.info(
-        f"Configuration reports for {args.get('simulation_software')} produced successfully."
+    app_context.logger.info(
+        f"Configuration reports for {app_context.args.get('simulation_software')} "
+        "produced successfully."
     )
-    logger.info(f"Output path: {output_path}/{args.get('model_version')}/")
+    app_context.logger.info(f"Output path: {output_path}")
 
 
 if __name__ == "__main__":

simtools/applications/generate_array_config.py

@@ -25,50 +25,31 @@ North - 5.0.0:
 The output is saved in simtools-output/test/model.
 """
 
-import logging
-from pathlib import Path
-
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.model.array_model import ArrayModel
 
 
-def _parse(label, description):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label : str
-        Label describing the application.
-    description : str
-        Description of the application.
-
-    Returns
-    -------
-    CommandLineParser
-        Command line parser object.
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Generate sim_telarray configuration files for a given array.",
+    )
     return config.initialize(db_config=True, simulation_model=["site", "layout", "model_version"])
 
 
 def main():
     """Generate sim_telarray configuration files for a given array."""
-    args_dict, db_config = _parse(
-        label=Path(__file__).stem,
-        description=("Generate sim_telarray configuration files for a given array."),
-    )
-    logger = logging.getLogger("simtools")
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    app_context = startup_application(_parse)
 
     array_model = ArrayModel(
-        label=args_dict["label"],
-        model_version=args_dict["model_version"],
-        mongo_db_config=db_config,
-        site=args_dict.get("site"),
-        layout_name=args_dict.get("array_layout_name"),
-        array_elements=args_dict.get("array_elements"),
+        label=app_context.args["label"],
+        model_version=app_context.args["model_version"],
+        db_config=app_context.db_config,
+        site=app_context.args.get("site"),
+        layout_name=app_context.args.get("array_layout_name"),
+        array_elements=app_context.args.get("array_elements"),
     )
     array_model.print_telescope_list()
     array_model.export_all_simtel_config_files()

simtools/applications/generate_corsika_histograms.py

@@ -164,36 +164,19 @@ r"""
         Total time needed: 8s.
 """
 
-import logging
 import time
-from pathlib import Path
 
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.corsika.corsika_histograms import CorsikaHistograms
-from simtools.io import io_handler
 
-logger = logging.getLogger()
 
-
-def _parse(label, description):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label: str
-        Label describing the application.
-    description: str
-        Description of the application.
-
-    Returns
-    -------
-    CommandLineParser
-        Command line parser object
-
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Generate histograms for the Cherenkov photons saved in the CORSIKA IACT file.",
+    )
 
     config.parser.add_argument(
         "--iact_file",
@@ -280,34 +263,30 @@ def _parse(label, description):
     return config_parser, _
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    description = "Generate histograms for the Cherenkov photons saved in the CORSIKA IACT file."
-    io_handler_instance = io_handler.IOHandler()
-    args_dict, _ = _parse(label, description)
-
-    output_path = io_handler_instance.get_output_directory()
+def main():
+    """Generate a set of histograms for the Cherenkov photons saved in the CORSIKA IACT file."""
+    app_context = startup_application(_parse)
 
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
     initial_time = time.time()
-    logger.info("Starting the application.")
 
     corsika_histograms_instance = CorsikaHistograms(
-        args_dict["iact_file"], output_path=output_path, hdf5_file_name=args_dict["hdf5_file_name"]
+        app_context.args["iact_file"],
+        output_path=app_context.io_handler.get_output_directory(),
+        hdf5_file_name=app_context.args["hdf5_file_name"],
     )
     corsika_histograms_instance.run_export_pipeline(
-        individual_telescopes=args_dict["individual_telescopes"],
-        hist_config=args_dict["hist_config"],
-        indices_arg=args_dict["telescope_indices"],
-        write_pdf=args_dict["pdf"],
-        write_hdf5=args_dict["hdf5"],
-        event1d=args_dict["event_1d_histograms"],
-        event2d=args_dict["event_2d_histograms"],
-        test=args_dict["test"],
+        individual_telescopes=app_context.args["individual_telescopes"],
+        hist_config=app_context.args["hist_config"],
+        indices_arg=app_context.args["telescope_indices"],
+        write_pdf=app_context.args["pdf"],
+        write_hdf5=app_context.args["hdf5"],
+        event1d=app_context.args["event_1d_histograms"],
+        event2d=app_context.args["event_2d_histograms"],
+        test=app_context.args["test"],
     )
 
     final_time = time.time()
-    logger.info(
+    app_context.logger.info(
         f"Finalizing the application. Total time needed: {round(final_time - initial_time)}s."
     )
 

simtools/applications/generate_default_metadata.py

@@ -21,33 +21,18 @@ r"""
 
     """
 
-import logging
-from pathlib import Path
-
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.data_model import metadata_model
-from simtools.io import ascii_handler, io_handler
-
-
-def _parse(label, description):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label: str
-        Label describing application.
-    description: str
-        Description of application.
+from simtools.io import ascii_handler
 
-    Returns
-    -------
-    CommandLineParser
-        Command line parser object
 
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Generate a default simtools metadata file from a json schema.",
+    )
 
     config.parser.add_argument(
         "--schema",
@@ -65,23 +50,17 @@ def _parse(label, description):
     return config.initialize(output=False, require_command_line=True)
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, _ = _parse(
-        label, description="Generate a default simtools metadata file from a json schema."
-    )
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Generate a default simtools metadata file from a json schema."""
+    app_context = startup_application(_parse)
 
-    default_values = metadata_model.get_default_metadata_dict(args_dict["schema"])
+    default_values = metadata_model.get_default_metadata_dict(app_context.args["schema"])
 
-    if args_dict["output_file"] is None:
+    if app_context.args["output_file"] is None:
         print(default_values)
     else:
-        _io_handler = io_handler.IOHandler()
-        output_file = _io_handler.get_output_file(args_dict["output_file"])
-        logger.info(f"Writing default values to {output_file}")
+        output_file = app_context.io_handler.get_output_file(app_context.args["output_file"])
+        app_context.logger.info(f"Writing default values to {output_file}")
         ascii_handler.write_data_to_file(
             data=default_values, output_file=output_file, sort_keys=False
         )