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

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

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

@@ -7,11 +7,11 @@ to production tables and model parameters as provided in a YAML file (see the ex
 
 Two main use cases are covered by this script:
 
-1. full_update: Create a complete new set of production tables (e.g. for new major or minor
+1. full update: Create a complete new set of production tables (e.g. for new major or minor
    versions of the simulation models). This will copy all production tables from the source
    directory and apply the modifications to the tables that are listed in the modifications file.
 
-2. patch_update: Create a set of new production tables including the changes defined in the
+2. patch update: Create a set of new production tables including the changes defined in the
    modifications file. No unmodified tables are copied. For new production tables with patch
    modifications, the key-value pair 'base_model_version: <base_model version>' is added.
 
@@ -27,78 +27,47 @@ The following example applies a patch update with changes defined in a YAML file
 
     simtools-maintain-simulation-model-add-new-production \\
         --simulation_models_path ../simulation-models-dev/simulation-models/ \\
-        --base_model_version 6.0.0 \\
-        --modifications tests/resources/production_tables_changes_for_threshold_study_6.2.0.yml \\
-        --patch_update
+        --modifications tests/resources/production_tables_changes_for_threshold_study_6.2.0.yml
 
 """
 
-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,
         required=True,
         help="Path to the simulation models repository.",
     )
-    config.parser.add_argument(
-        "--base_model_version",
-        type=str,
-        required=True,
-        help="Base model version (which is the source production table subdirectory to copy from).",
-    )
     config.parser.add_argument(
         "--modifications",
         type=str,
         required=True,
         help="File containing the list of changes to apply.",
     )
-    update_group = config.parser.add_mutually_exclusive_group(required=True)
-    update_group.add_argument(
-        "--full_update",
-        action="store_true",
-        default=False,
-        help=(
-            "Create a full new set of production tables by copying all tables from the "
-            "base version and applying the modifications to the relevant tables."
-        ),
-    )
-    update_group.add_argument(
-        "--patch_update",
-        action="store_true",
-        default=False,
-        help=(
-            "Create a new set of production tables including only the changes defined in the "
-            "modifications file. No unmodified tables are copied."
-        ),
-    )
 
     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(args_dict)
+    model_repository.generate_new_production(
+        modifications=app_context.args["modifications"],
+        simulation_models_path=Path(app_context.args["simulation_models_path"]),
+    )
 
 
 if __name__ == "__main__":

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(label)
-    output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
+    output_path = io_handler.IOHandler().get_output_directory()
+    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,
     )