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

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,29 +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(label, sub_dir="application-plots")
-            / 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__":

simtools/applications/plot_tabular_data.py

@@ -23,37 +23,24 @@ Plot tabular data using a configuration 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.constants import PLOT_CONFIG_SCHEMA
 from simtools.data_model import schema
 from simtools.data_model.metadata_collector import MetadataCollector
-from simtools.io import ascii_handler, io_handler
+from simtools.io import ascii_handler
 from simtools.visualization import plot_tables
 
 
-def _parse(label, description, usage):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label : str
-        Label describing the application.
-    description : str
-        Description of the application.
-    usage : str
-        Example on how to use the application.
-
-    Returns
-    -------
-    CommandLineParser
-        Command line parser object.
-    """
-    config = configurator.Configurator(label=label, description=description, usage=usage)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Plots tabular data.",
+        usage="""simtools-plot-tabular-data --plot_config config_file_name "
+                 --output_file output_file_name""",
+    )
 
     config.parser.add_argument(
         "--plot_config",
@@ -79,33 +66,25 @@ def _parse(label, description, usage):
 
 def main():
     """Plot tabular data."""
-    args_dict, db_config_ = _parse(
-        label=Path(__file__).stem,
-        description="Plots tabular data.",
-        usage="""simtools-plot-tabular-data --plot_config config_file_name "
-                 --output_file output_file_name""",
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict.get("log_level", "INFO")))
-    io_handler_instance = io_handler.IOHandler()
+    app_context = startup_application(_parse)
 
     plot_config = gen.convert_keys_in_dict_to_lowercase(
         schema.validate_dict_using_schema(
-            ascii_handler.collect_data_from_file(args_dict["plot_config"]),
+            ascii_handler.collect_data_from_file(app_context.args["plot_config"]),
             PLOT_CONFIG_SCHEMA,
         )
     )
 
     plot_tables.plot(
         config=plot_config["plot"],
-        output_file=io_handler_instance.get_output_file(args_dict["output_file"]),
-        db_config=db_config_,
-        data_path=args_dict.get("table_data_path"),
+        output_file=app_context.io_handler.get_output_file(app_context.args["output_file"]),
+        db_config=app_context.db_config,
+        data_path=app_context.args.get("table_data_path"),
     )
 
     MetadataCollector.dump(
-        args_dict,
-        io_handler_instance.get_output_file(args_dict["output_file"]),
+        app_context.args,
+        app_context.io_handler.get_output_file(app_context.args["output_file"]),
         add_activity_name=True,
     )
 

simtools/applications/plot_tabular_data_for_model_parameter.py

@@ -46,19 +46,18 @@ Plot tabular data for all types defined in the schema 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.data_model.metadata_collector import MetadataCollector
-from simtools.io import io_handler
 from simtools.visualization import plot_tables
 
 
-def _parse(label, description):
+def _parse():
     """Parse command line configuration."""
-    config = configurator.Configurator(label=label, description=description)
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Plots tabular data for a model parameter.",
+    )
 
     config.parser.add_argument("--parameter", type=str, required=True, help="Parameter name.")
     config.parser.add_argument(
@@ -73,31 +72,25 @@ def _parse(label, description):
 
 def main():
     """Plot tabular data."""
-    args_dict, db_config = _parse(
-        label=Path(__file__).stem,
-        description="Plots tabular data for a model parameter.",
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict.get("log_level", "INFO")))
-    io_handler_instance = io_handler.IOHandler()
+    app_context = startup_application(_parse)
 
     plot_configs, output_files = plot_tables.generate_plot_configurations(
-        parameter=args_dict["parameter"],
-        parameter_version=args_dict["parameter_version"],
-        site=args_dict["site"],
-        telescope=args_dict.get("telescope"),
-        output_path=io_handler_instance.get_output_directory(),
-        plot_type=args_dict["plot_type"],
-        db_config=db_config,
+        parameter=app_context.args["parameter"],
+        parameter_version=app_context.args["parameter_version"],
+        site=app_context.args["site"],
+        telescope=app_context.args.get("telescope"),
+        output_path=app_context.io_handler.get_output_directory(),
+        plot_type=app_context.args["plot_type"],
+        db_config=app_context.db_config,
     )
 
     for plot_config, output_file in zip(plot_configs, output_files):
         plot_tables.plot(
             config=plot_config,
             output_file=output_file,
-            db_config=db_config,
+            db_config=app_context.db_config,
         )
-        MetadataCollector.dump(args_dict, output_file=output_file, add_activity_name=True)
+        MetadataCollector.dump(app_context.args, output_file=output_file, add_activity_name=True)
 
 
 if __name__ == "__main__":

simtools/applications/print_version.py

@@ -6,55 +6,27 @@ The versions of simtools, the DB, sim_telarray, and CORSIKA are printed.
 
 """
 
-import logging
-from pathlib import Path
-
 from simtools import dependencies, version
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
-from simtools.io import ascii_handler, io_handler
-from simtools.utils import general as gen
-
-
-def _parse(label, description, usage):
-    """
-    Parse command line configuration.
+from simtools.io import ascii_handler
 
-    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)
 
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Print the versions of simtools, the DB, sim_telarray and CORSIKA.",
+        usage="simtools-print-version",
+    )
     return config.initialize(db_config=True, output=True, require_command_line=False)
 
 
 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()
+    app_context = startup_application(_parse)
 
-    version_string = dependencies.get_version_string(db_config)
+    version_string = dependencies.get_version_string(app_context.db_config)
     version_dict = {"simtools version": version.__version__}
 
     print()
@@ -68,11 +40,11 @@ def main():
         key, value = version_entry.split(": ", 1)
         version_dict[key] = value
 
-    if not args_dict.get("output_file_from_default", False):
+    if not app_context.args.get("output_file_from_default", False):
         ascii_handler.write_data_to_file(
             data=version_dict,
-            output_file=io_handler_instance.get_output_file(
-                args_dict.get("output_file", "simtools_version.json"), label=label
+            output_file=app_context.io_handler.get_output_file(
+                app_context.args.get("output_file", "simtools_version.json")
             ),
         )
 

simtools/applications/production_derive_corsika_limits.py

@@ -82,9 +82,7 @@ Derive limits for a given file for custom defined array layouts:
         --output_file corsika_simulation_limits_lookup.ecsv
 """
 
-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.production_configuration.derive_corsika_limits import (
     generate_corsika_limits_grid,
@@ -94,7 +92,8 @@ from simtools.production_configuration.derive_corsika_limits import (
 def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        description="Derive limits for energy, radial distance, and viewcone."
+        label=get_application_label(__file__),
+        description="Derive limits for energy, radial distance, and viewcone.",
     )
     config.parser.add_argument(
         "--event_data_file",
@@ -133,12 +132,9 @@ def _parse():
 
 def main():
     """Derive limits for energy, radial distance, and viewcone."""
-    args_dict, db_config = _parse()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict.get("log_level", "info")))
+    app_context = startup_application(_parse)
 
-    generate_corsika_limits_grid(args_dict, db_config)
+    generate_corsika_limits_grid(app_context.args, app_context.db_config)
 
 
 if __name__ == "__main__":

simtools/applications/production_derive_statistics.py

@@ -50,27 +50,21 @@ The output will be a file containing the grid points with the derived number of
 added.
 """
 
-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.production_configuration.derive_production_statistics_handler import (
     ProductionStatisticsHandler,
 )
-from simtools.utils import general as gen
-
 
-def _parse(label, description):
-    """
-    Parse command line arguments for the statistical error evaluator application.
 
-    Returns
-    -------
-    argparse.Namespace
-        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=(
+            "Evaluate statistical uncertainties from DL2 MC event files and interpolate results."
+        ),
+    )
 
     config.parser.add_argument(
         "--grid_points_production_file",
@@ -139,19 +133,11 @@ def _parse(label, description):
 
 def main():
     """Run the ProductionStatisticsHandler."""
-    label = Path(__file__).stem
+    app_context = startup_application(_parse)
 
-    args_dict, _ = _parse(
-        label,
-        "Evaluate statistical uncertainties from DL2 MC event files and interpolate results.",
+    manager = ProductionStatisticsHandler(
+        app_context.args, output_path=app_context.io_handler.get_output_directory()
     )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    _io_handler = io_handler.IOHandler()
-    output_path = _io_handler.get_output_directory(label, sub_dir="")
-
-    manager = ProductionStatisticsHandler(args_dict, output_path=output_path)
     manager.run()