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

simtools/applications/generate_regular_arrays.py

@@ -24,14 +24,13 @@ Runtime < 10 s.
     simtools-generate-regular-arrays --site=North
 """
 
-import logging
 from pathlib import Path
 
 import astropy.units as u
 from astropy.table import QTable
 
 import simtools.data_model.model_data_writer as writer
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.utils import names
 
@@ -42,7 +41,7 @@ telescope_distance = {"LST": 57.5 * u.m, "MST": 70 * u.m, "SST": 80 * u.m}
 
 def _parse():
     config = configurator.Configurator(
-        label=Path(__file__).stem,
+        label=get_application_label(__file__),
         description=(
             "Generate a regular array of telescope and save as astropy table.\n"
             "Default telescope distances for 4 telescope square arrays are: \n"
@@ -58,18 +57,15 @@ def _parse():
 
 def main():
     """Create layout array files (ecsv) of regular arrays."""
-    args_dict, _ = _parse()
+    app_context = startup_application(_parse)
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    if args_dict["site"] == "South":
+    if app_context.args["site"] == "South":
         array_list = ["1SST", "4SST", "1MST", "4MST", "1LST", "4LST"]
     else:
         array_list = ["1MST", "4MST", "1LST", "4LST"]
 
     for array_name in array_list:
-        logger.info(f"Processing array {array_name}")
+        app_context.logger.info(f"Processing array {array_name}")
 
         tel_name, pos_x, pos_y, pos_z = [], [], [], []
         tel_size = array_name[1:4]
@@ -78,7 +74,7 @@ def main():
         if array_name[0] == "1":
             tel_name.append(
                 names.generate_array_element_name_from_type_site_id(
-                    tel_size, args_dict["site"], "01"
+                    tel_size, app_context.args["site"], "01"
                 )
             )
             pos_x.append(0 * u.m)
@@ -89,14 +85,14 @@ def main():
             for i in range(1, 5):
                 tel_name.append(
                     names.generate_array_element_name_from_type_site_id(
-                        tel_size, args_dict["site"], f"0{i}"
+                        tel_size, app_context.args["site"], f"0{i}"
                     )
                 )
                 pos_x.append(telescope_distance[tel_size] * (-1) ** (i // 2))
                 pos_y.append(telescope_distance[tel_size] * (-1) ** (i % 2))
                 pos_z.append(0 * u.m)
 
-        table = QTable(meta={"array_name": array_name, "site": args_dict["site"]})
+        table = QTable(meta={"array_name": array_name, "site": app_context.args["site"]})
         table["telescope_name"] = tel_name
         table["position_x"] = pos_x
         table["position_y"] = pos_y
@@ -104,14 +100,14 @@ def main():
         table.sort("telescope_name")
         table.pprint()
 
-        output_file = args_dict.get("output_file")
+        output_file = app_context.args.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}"
+                f"{output_path.stem}-{app_context.args['site']}-{array_name}{output_path.suffix}"
             )
         writer.ModelDataWriter.dump(
-            args_dict=args_dict,
+            args_dict=app_context.args,
             output_file=output_file,
             metadata=None,
             product_data=table,

simtools/applications/generate_simtel_event_data.py

@@ -124,26 +124,24 @@ To read a reduced event data file, use the following command reading on of the t
 
 """
 
-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.metadata_collector import MetadataCollector
 from simtools.io import io_handler, table_handler
 from simtools.simtel.simtel_io_event_writer import SimtelIOEventDataWriter
 
 
-def _parse(label, description):
-    """
-    Parse command line arguments.
-
-    Returns
-    -------
-    dict
-        Parsed command-line arguments.
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line arguments."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description=(
+            "Process files and store reduced dataset with event information, "
+            "array information and triggered telescopes."
+        ),
+    )
 
     config.parser.add_argument(
         "--input",
@@ -163,36 +161,28 @@ def _parse(label, description):
     return config.initialize(db_config=False, output=True)
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-
-    args_dict, _ = _parse(
-        label=label,
-        description=(
-            "Process files and store reduced dataset with event information, "
-            "array information and triggered telescopes."
-        ),
-    )
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-    logger.info(f"Loading input files from: {args_dict['input']}")
+def main():
+    """Generate a reduced dataset of event data from output of telescope simulations."""
+    app_context = startup_application(_parse, setup_io_handler=False)
+    app_context.logger.info(f"Loading input files from: {app_context.args['input']}")
 
-    input_pattern = Path(args_dict["input"])
+    input_pattern = Path(app_context.args["input"])
     files = list(input_pattern.parent.glob(input_pattern.name))
     if not files:
-        logger.warning("No matching input files found.")
+        app_context.logger.warning("No matching input files found.")
         return
 
-    output_filepath = io_handler.IOHandler().get_output_file(args_dict["output_file"])
-    generator = SimtelIOEventDataWriter(files, args_dict["max_files"])
+    output_filepath = io_handler.IOHandler().get_output_file(app_context.args["output_file"])
+    generator = SimtelIOEventDataWriter(files, app_context.args["max_files"])
     tables = generator.process_files()
     table_handler.write_tables(tables, output_filepath, overwrite_existing=True)
-    MetadataCollector.dump(args_dict=args_dict, output_file=output_filepath.with_suffix(".yml"))
+    MetadataCollector.dump(
+        args_dict=app_context.args, output_file=output_filepath.with_suffix(".yml")
+    )
 
-    if args_dict["print_dataset_information"] > 0:
+    if app_context.args["print_dataset_information"] > 0:
         for table in tables:
-            table.pprint(max_lines=args_dict["print_dataset_information"], max_width=-1)
+            table.pprint(max_lines=app_context.args["print_dataset_information"], max_width=-1)
 
 
 if __name__ == "__main__":

simtools/applications/maintain_simulation_model_add_production.py

@@ -31,24 +31,19 @@ The following example applies a patch update with changes defined in a YAML file
 
 """
 
-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 import model_repository
 
 
-def _parse(label, description):
-    """
-    Parse command line arguments.
-
-    Returns
-    -------
-    dict
-        Parsed command-line arguments.
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line arguments."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Generate a new simulation model production",
+    )
     config.parser.add_argument(
         "--simulation_models_path",
         type=str,
@@ -65,15 +60,13 @@ def _parse(label, description):
     return config.initialize(db_config=False, output=False)
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, _ = _parse(label=label, description="Generate a new simulation model production")
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Generate a new simulation model production."""
+    app_context = startup_application(_parse)
 
     model_repository.generate_new_production(
-        modifications=args_dict["modifications"],
-        simulation_models_path=Path(args_dict["simulation_models_path"]),
+        modifications=app_context.args["modifications"],
+        simulation_models_path=Path(app_context.args["simulation_models_path"]),
     )
 
 

simtools/applications/maintain_simulation_model_compare_productions.py

@@ -13,17 +13,20 @@ Example
 
 """
 
-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.io import ascii_handler
 
 
-def _parse(label, description):
+def _parse():
     """Parse command line arguments."""
-    config = configurator.Configurator(label=label, description=description)
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Compare two directories with model production tables in JSON format.",
+    )
     config.parser.add_argument(
         "--directory_1",
         type=str,
@@ -82,16 +85,11 @@ def _compare_json_dirs(dir1, dir2, ignore_key="model_version"):
             print(f"Missing in dir1: {rel_path}")
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, _ = _parse(
-        label=label,
-        description=("Compare two directories with model production tables in JSON format."),
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Compare two directories with model production tables in JSON format."""
+    app_context = startup_application(_parse, setup_io_handler=False)
 
-    _compare_json_dirs(Path(args_dict["directory_1"]), Path(args_dict["directory_2"]))
+    _compare_json_dirs(Path(app_context.args["directory_1"]), Path(app_context.args["directory_2"]))
 
 
 if __name__ == "__main__":

simtools/applications/maintain_simulation_model_verify_production_tables.py

@@ -17,21 +17,20 @@ Example
 
 """
 
-import logging
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
 from simtools.model import model_repository
-from simtools.utils import general as gen
 
 
 def _parse():
-    """Parse command line arguments."""
+    """Parse command line configuration."""
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description=(
             "Verify simulation model production tables and model parameters for completeness. "
             "This application checks that all model parameters defined in the production tables "
             "exist in the simulation models repository."
-        )
+        ),
     )
     config.parser.add_argument(
         "--simulation_models_path",
@@ -42,14 +41,12 @@ def _parse():
     return config.initialize(db_config=False, output=False, paths=False)
 
 
-def main():  # noqa: D103
-    args_dict, _ = _parse()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Verify simulation model production tables."""
+    app_context = startup_application(_parse)
 
     if not model_repository.verify_simulation_model_production_tables(
-        simulation_models_path=args_dict["simulation_models_path"]
+        simulation_models_path=app_context.args["simulation_models_path"]
     ):
         raise RuntimeError(
             "Verification failed: Some model parameters are missing in the repository."

simtools/applications/merge_tables.py

@@ -36,24 +36,20 @@ Merge tables from two files generated with 'simtools-generate-simtel-event-data'
 
 """
 
-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.io import io_handler, table_handler
 
 
-def _parse(label, description):
-    """
-    Parse command line arguments.
-
-    Returns
-    -------
-    dict
-        Parsed command-line arguments.
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line arguments."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Merge tables from multiple input files into single tables.",
+    )
 
     input_group = config.parser.add_mutually_exclusive_group(required=True)
     input_group.add_argument(
@@ -72,28 +68,23 @@ def _parse(label, description):
     return config.initialize(db_config=False, output=True)
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
+def main():
+    """Merge tables from multiple input files into single tables."""
+    app_context = startup_application(_parse)
 
-    args_dict, _ = _parse(
-        label=label,
-        description=("Merge tables from multiple input files into single tables."),
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-    logger.info(f"Loading input files: {args_dict['input_files']}")
+    app_context.logger.info(f"Loading input files: {app_context.args['input_files']}")
 
     # accept fits.gz files (.gz)
     input_files = gen.get_list_of_files_from_command_line(
-        args_dict["input_files"], [".hdf5", ".gz"]
+        app_context.args["input_files"], [".hdf5", ".gz"]
     )
 
     output_path = io_handler.IOHandler().get_output_directory()
-    output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
+    output_filepath = Path(output_path).joinpath(f"{app_context.args['output_file']}")
 
     table_handler.merge_tables(
         input_files,
-        input_table_names=args_dict["table_names"],
+        input_table_names=app_context.args["table_names"],
         output_file=output_filepath,
     )
 

simtools/applications/plot_array_layout.py

@@ -56,6 +56,12 @@ axes_range : float, optional
     Range of the both axes in meters.
 marker_scaling : float, optional.
     Scaling factor for plotting of array elements, optional.
+grayed_out_array_elements : list, optional
+    List of array elements to plot as gray circles.
+highlighted_array_elements : list, optional
+    List of array elements to plot with red circles around them.
+legend_location : str, optional
+    Location of the legend (default "best").
 
 Examples
 --------
@@ -97,41 +103,39 @@ Plot all layouts for the North site and model version 6.0.0:
 .. code-block:: console
 
     simtools-plot-array-layout --site North --plot_all_layouts --model_version=6.0.0
-"""
 
-import logging
-from pathlib import Path
+Plot layout with some telescopes grayed out and others highlighted:
+
+.. code-block:: console
+
+    simtools-plot-array-layout --site North
+                               --array_layout_name alpha
+                               --model_version=6.0.0
+                               --grayed_out_array_elements LSTN-01 LSTN-02
+                               --highlighted_array_elements MSTN-01 MSTN-02
+                               --legend_location "upper right"
+"""
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
 import simtools.layout.array_layout_utils as layout_utils
-import simtools.utils.general as gen
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io import io_handler
 from simtools.visualization import visualize
 from simtools.visualization.plot_array_layout import plot_array_layout
 
 
-def _parse(label, description, usage=None):
-    """
-    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)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Plots array layout.",
+        usage=(
+            "Use '--array_layout_name plot_all' to plot all layouts for the given site "
+            "and model version."
+        ),
+    )
 
     config.parser.add_argument(
         "--figure_name",
@@ -176,6 +180,33 @@ def _parse(label, description, usage=None):
         required=False,
         default=None,
     )
+    config.parser.add_argument(
+        "--grayed_out_array_elements",
+        help="List of array elements to plot as gray circles.",
+        type=str,
+        nargs="*",
+        required=False,
+        default=None,
+    )
+    config.parser.add_argument(
+        "--highlighted_array_elements",
+        help="List of array elements to plot with red circles around them.",
+        type=str,
+        nargs="*",
+        required=False,
+        default=None,
+    )
+    config.parser.add_argument(
+        "--legend_location",
+        help=(
+            "Location of the legend (e.g., 'best', 'upper right', 'upper left', "
+            "'lower left', 'lower right', 'right', 'center left', 'center right', "
+            "'lower center', 'upper center', 'center')."
+        ),
+        type=str,
+        required=False,
+        default="best",
+    )
     return config.initialize(
         db_config=True,
         simulation_model=[
@@ -199,8 +230,8 @@ def read_layouts(args_dict, db_config, logger):
         Dictionary with command line arguments.
     db_config : dict
         Database configuration.
-    logger : logging.Logger
-        Logger instance.
+    logger : logging.app_context.logger
+        app_context.logger instance.
 
     Returns
     -------
@@ -248,28 +279,17 @@ def read_layouts(args_dict, db_config, logger):
 
 def main():
     """Plot array layout application."""
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(
-        label,
-        (
-            "Plots array layout."
-            "Use '--array_layout_name plot_all' to plot all layouts for the given site "
-            "and model version."
-        ),
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-    io_handler_instance = io_handler.IOHandler()
+    app_context = startup_application(_parse)
 
-    layouts = read_layouts(args_dict, db_config, logger)
+    layouts = read_layouts(app_context.args, app_context.db_config, app_context.logger)
 
-    if args_dict.get("array_layout_name_background"):
+    if app_context.args.get("array_layout_name_background"):
         background_layout = layout_utils.get_array_layouts_from_db(
-            args_dict["array_layout_name_background"],
-            args_dict["site"],
-            args_dict["model_version"],
-            db_config,
-            args_dict["coordinate_system"],
+            app_context.args["array_layout_name_background"],
+            app_context.args["site"],
+            app_context.args["model_version"],
+            app_context.db_config,
+            app_context.args["coordinate_system"],
         )["array_elements"]
     else:
         background_layout = None
@@ -278,28 +298,31 @@ def main():
     for layout in layouts:
         fig_out = plot_array_layout(
             telescopes=layout["array_elements"],
-            show_tel_label=args_dict["show_labels"],
-            axes_range=args_dict["axes_range"],
-            marker_scaling=args_dict["marker_scaling"],
+            show_tel_label=app_context.args["show_labels"],
+            axes_range=app_context.args["axes_range"],
+            marker_scaling=app_context.args["marker_scaling"],
             background_telescopes=background_layout,
+            grayed_out_elements=app_context.args["grayed_out_array_elements"],
+            highlighted_elements=app_context.args["highlighted_array_elements"],
+            legend_location=app_context.args["legend_location"],
         )
         site_string = ""
         if layout.get("site") is not None:
             site_string = f"_{layout['site']}"
-        elif args_dict["site"] is not None:
-            site_string = f"_{args_dict['site']}"
+        elif app_context.args["site"] is not None:
+            site_string = f"_{app_context.args['site']}"
         coordinate_system_string = (
-            f"_{args_dict['coordinate_system']}"
-            if args_dict["coordinate_system"] not in layout["name"]
+            f"_{app_context.args['coordinate_system']}"
+            if app_context.args["coordinate_system"] not in layout["name"]
             else ""
         )
-        plot_file_name = args_dict["figure_name"] or (
+        plot_file_name = app_context.args["figure_name"] or (
             f"array_layout_{layout['name']}{site_string}{coordinate_system_string}"
         )
 
         visualize.save_figure(
             fig_out,
-            io_handler_instance.get_output_directory() / plot_file_name,
+            app_context.io_handler.get_output_directory() / plot_file_name,
             dpi=400,
         )
         plt.close()

simtools/applications/plot_simtel_events.py

@@ -76,19 +76,18 @@ Examples
 
 """
 
-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.io import io_handler
 from simtools.visualization.plot_simtel_events import PLOT_CHOICES, generate_and_save_plots
 
 
-def _parse(label: str):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=(
             "Create diagnostic plots from sim_telarray files using simtools visualization."
         ),
@@ -178,17 +177,16 @@ def _parse(label: str):
 
 def main():
     """Generate plots from sim_telarray files."""
-    label = Path(__file__).stem
-    args, _db = _parse(label)
+    app_context = startup_application(_parse)
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args.get("log_level", "INFO")))
+    simtel_files = [
+        Path(p).expanduser() for p in gen.ensure_iterable(app_context.args["simtel_files"])
+    ]
+    plots = list(gen.ensure_iterable(app_context.args.get("plots")))
 
-    ioh = io_handler.IOHandler()
-    simtel_files = [Path(p).expanduser() for p in gen.ensure_iterable(args["simtel_files"])]
-    plots = list(gen.ensure_iterable(args.get("plots")))
-
-    generate_and_save_plots(simtel_files=simtel_files, plots=plots, args=args, ioh=ioh)
+    generate_and_save_plots(
+        simtel_files=simtel_files, plots=plots, args=app_context.args, ioh=app_context.io_handler
+    )
 
 
 if __name__ == "__main__":