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

simtools/applications/calculate_incident_angles.py

@@ -71,18 +71,17 @@ Example of a secondary mirror incident angle plot for a SST:
     :width: 49 %
 """
 
-import logging
-from pathlib import Path
-
+from simtools.application_control import get_application_label, startup_application
 from simtools.configuration import configurator
+from simtools.configuration.commandline_parser import CommandLineParser
 from simtools.ray_tracing.incident_angles import IncidentAnglesCalculator
 from simtools.visualization.plot_incident_angles import plot_incident_angles
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=(
             "Calculate photon incident angles on focal plane and primary/secondary mirrors."
         ),
@@ -104,7 +103,7 @@ def _parse(label):
     config.parser.add_argument(
         "--number_of_photons",
         help="Number of star photons to trace (per run)",
-        type=int,
+        type=CommandLineParser.scientific_int,
         default=10000,
         required=False,
     )
@@ -135,38 +134,31 @@ def _parse(label):
 
 
 def main():
-    """Application to calculate incident angles using ray tracing."""
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(label)
-
-    logger = logging.getLogger()
-    logger.setLevel(logging.INFO)
+    """Calculate photon incident angles on focal plane and primary/secondary mirrors."""
+    app_context = startup_application(_parse)
 
-    logger.info("Starting calculation of incident angles")
+    app_context.logger.info("Starting calculation of incident angles")
 
-    output_base = Path(args_dict.get("output_path", "./"))
-    output_dir = (
-        output_base / label if not args_dict.get("use_plain_output_path", False) else output_base
-    )
-    base_label = args_dict.get("label", label)
-    telescope_name = args_dict["telescope"]
+    output_dir = app_context.io_handler.get_output_directory()
+    base_label = app_context.args.get("label", get_application_label(__file__))
+    telescope_name = app_context.args["telescope"]
     label_with_telescope = f"{base_label}_{telescope_name}"
 
     calculator = IncidentAnglesCalculator(
-        simtel_path=args_dict["simtel_path"],
-        db_config=db_config,
-        config_data=args_dict,
+        simtel_path=app_context.args["simtel_path"],
+        db_config=app_context.db_config,
+        config_data=app_context.args,
         output_dir=output_dir,
         label=base_label,
     )
-    offsets = [float(v) for v in args_dict.get("off_axis_angles", [0.0])]
+    offsets = [float(v) for v in app_context.args.get("off_axis_angles", [0.0])]
 
     results_by_offset = calculator.run_for_offsets(offsets)
     plot_incident_angles(
         results_by_offset,
         output_dir,
         label_with_telescope,
-        debug_plots=args_dict.get("debug_plots", False),
+        debug_plots=app_context.args.get("debug_plots", False),
     )
     total = sum(len(t) for t in results_by_offset.values())
     summary_msg = (
@@ -175,7 +167,7 @@ def main():
     )
     if total < 1_000_000:
         summary_msg += " (below 1e6; results may be statistically unstable)"
-    logger.info(summary_msg)
+    app_context.logger.info(summary_msg)
 
 
 if __name__ == "__main__":

simtools/applications/convert_all_model_parameters_from_simtel.py

@@ -60,38 +60,24 @@ r"""
 
 """
 
-import logging
 from pathlib import Path
 
 import numpy as np
 
 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.data_model import schema
 from simtools.io import ascii_handler
-from simtools.io.io_handler import IOHandler
 from simtools.simtel import simtel_config_reader
 
 
-def _parse(label=None, description=None):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label: str
-        Label describing application.
-    description: str
-        Description of 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="Convert all model parameters from sim_telarray",
+    )
 
     config.parser.add_argument(
         "--simtel_cfg_file",
@@ -156,8 +142,8 @@ def get_number_of_camera_pixel(args_dict, logger):
     ----------
     args_dict: dict
         Dictionary with command line arguments.
-    logger: logging.Logger
-        Logger object
+    logger: logging.logger
+        logger object
 
     Returns
     -------
@@ -177,7 +163,7 @@ def get_number_of_camera_pixel(args_dict, logger):
     return _camera_pixel
 
 
-def read_and_export_parameters(args_dict, logger):
+def read_and_export_parameters(args_dict, logger, io_handler):
     """
     Read and export parameters from sim_telarray configuration file to json files.
 
@@ -188,8 +174,10 @@ def read_and_export_parameters(args_dict, logger):
     ----------
     args_dict: dict
         Dictionary with command line arguments.
-    logger: logging.Logger
-        Logger object
+    logger: logging.logger
+        logger object
+    io_handler: IOHandler
+        IOHandler object
 
     Returns
     -------
@@ -205,9 +193,6 @@ def read_and_export_parameters(args_dict, logger):
     )
     logger.info(f"Found {len(_simtel_parameters)} parameters in sim_telarray configuration file.")
 
-    io_handler = IOHandler()
-    io_handler.set_paths(output_path=args_dict["output_path"])
-
     _camera_pixel = get_number_of_camera_pixel(args_dict, logger)
 
     _parameters_not_in_simtel = []
@@ -233,8 +218,7 @@ def read_and_export_parameters(args_dict, logger):
             parameter_version=args_dict["parameter_version"],
             output_file=io_handler.get_output_file(
                 f"{_parameter}-{args_dict['parameter_version']}.json",
-                label=f"{args_dict['telescope']}",
-                sub_dir=f"{_parameter}",
+                sub_dir=[f"{args_dict['telescope']}", f"{_parameter}"],
             ),
         )
 
@@ -264,8 +248,8 @@ def print_parameters_not_found(_parameters_not_in_simtel, _simtel_parameters, ar
         List of sim_telarray parameters not found in simtools schema files.
     args_dict: dict
         Dictionary with command line arguments.
-    logger: logging.Logger
-        Logger object
+    logger: logging.logger
+        logger object
 
     """
     logger.info(
@@ -314,8 +298,8 @@ def print_list_of_files(args_dict, logger):
     ----------
     args_dict: dict
         Dictionary with command line arguments.
-    logger: logging.Logger
-        Logger object
+    logger: logging.logger
+        logger object
 
     """
     model_files = sorted(Path(args_dict["output_path"]).rglob("*.json"))
@@ -325,17 +309,17 @@ def print_list_of_files(args_dict, logger):
             logger.info(f"{file.name}: {model_dict['value']}")
 
 
-def main():  # noqa: D103
-    args_dict, _ = _parse(
-        label=Path(__file__).stem,
-        description="Convert simulation model parameters from sim_telarray to simtools format.",
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Convert all simulation model parameters exported from sim_telarray format."""
+    app_context = startup_application(_parse)
 
-    _parameters_not_in_simtel, _simtel_parameters = read_and_export_parameters(args_dict, logger)
-    print_parameters_not_found(_parameters_not_in_simtel, _simtel_parameters, args_dict, logger)
-    print_list_of_files(args_dict, logger)
+    _parameters_not_in_simtel, _simtel_parameters = read_and_export_parameters(
+        app_context.args, app_context.logger, app_context.io_handler
+    )
+    print_parameters_not_found(
+        _parameters_not_in_simtel, _simtel_parameters, app_context.args, app_context.logger
+    )
+    print_list_of_files(app_context.args, app_context.logger)
 
 
 if __name__ == "__main__":

simtools/applications/convert_geo_coordinates_of_array_elements.py

@@ -54,33 +54,19 @@ Expected output is a ecsv file in the directory printed to the screen.
 
 """
 
-import logging
-from pathlib import Path
-
 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.data_model.metadata_collector import MetadataCollector
 from simtools.layout import array_layout
 
 
-def _parse(label=None, description=None):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label: str
-        Label describing application.
-    description: str
-        Description of 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="Print a list of array element positions",
+    )
 
     config.parser.add_argument(
         "--input",
@@ -139,52 +125,47 @@ def _parse(label=None, description=None):
 
 def main():
     """Print a list of array elements."""
-    label = Path(__file__).stem
-    model_parameter_name = "array_coordinates"
-    args_dict, db_config = _parse(
-        label,
-        description=f"Print a list of array element positions ({model_parameter_name})",
-    )
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    app_context = startup_application(_parse)
 
-    if args_dict.get("input", "").endswith(".json"):
-        site = args_dict.get("site", None)
+    if app_context.args.get("input", "").endswith(".json"):
+        site = app_context.args.get("site", None)
         metadata, validate_schema_file = None, None
     else:
-        metadata = MetadataCollector(args_dict=args_dict, model_parameter_name=model_parameter_name)
+        metadata = MetadataCollector(
+            args_dict=app_context.args, model_parameter_name="array_coordinates"
+        )
         site = metadata.get_site(from_input_meta=True)
         validate_schema_file = metadata.get_data_model_schema_file_name()
 
     layout = array_layout.ArrayLayout(
-        mongo_db_config=db_config,
-        model_version=args_dict["model_version"],
+        mongo_db_config=app_context.db_config,
+        model_version=app_context.args["model_version"],
         site=site,
-        telescope_list_file=args_dict["input"],
-        telescope_list_metadata_file=args_dict["input_meta"],
-        validate=not args_dict["skip_input_validation"],
+        telescope_list_file=app_context.args["input"],
+        telescope_list_metadata_file=app_context.args["input_meta"],
+        validate=not app_context.args["skip_input_validation"],
     )
-    layout.select_assets(args_dict["select_assets"])
+    layout.select_assets(app_context.args["select_assets"])
     layout.convert_coordinates()
 
-    if args_dict["export"] is not None:
+    if app_context.args["export"] is not None:
         product_data = (
             layout.export_one_telescope_as_json(
-                crs_name=args_dict["export"], parameter_version=args_dict.get("parameter_version")
+                crs_name=app_context.args["export"],
+                parameter_version=app_context.args.get("parameter_version"),
             )
-            if args_dict.get("input", "").endswith(".json")
-            else layout.export_telescope_list_table(crs_name=args_dict["export"])
+            if app_context.args.get("input", "").endswith(".json")
+            else layout.export_telescope_list_table(crs_name=app_context.args["export"])
         )
         writer.ModelDataWriter.dump(
-            args_dict=args_dict,
+            args_dict=app_context.args,
             metadata=metadata,
             product_data=product_data,
             validate_schema_file=validate_schema_file,
         )
     else:
         layout.print_telescope_list(
-            crs_name=args_dict["print"],
+            crs_name=app_context.args["print"],
         )
 
 

simtools/applications/convert_model_parameter_from_simtel.py

@@ -35,33 +35,18 @@ r"""
 
 """
 
-import logging
-from pathlib import Path
-
 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.simtel.simtel_config_reader import SimtelConfigReader
 
 
-def _parse(label=None, description=None):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label: str
-        Label describing application.
-    description: str
-        Description of 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="Convert simulation model parameter from sim_telarray to simtools format.",
+    )
 
     config.parser.add_argument(
         "--schema", help="Schema file for model parameter validation", required=True
@@ -81,37 +66,31 @@ def _parse(label=None, description=None):
     return config.initialize(simulation_model=["telescope", "parameter_version"], output=True)
 
 
-def main():  # noqa: D103
-    args_dict, _ = _parse(
-        label=Path(__file__).stem,
-        description="Convert simulation model parameter from sim_telarray to simtools format.",
-    )
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Convert simulation model parameter from sim_telarray to simtools format."""
+    app_context = startup_application(_parse, setup_io_handler=False)
 
     simtel_config_reader = SimtelConfigReader(
-        schema_file=args_dict["schema"],
-        simtel_config_file=args_dict["simtel_cfg_file"],
-        simtel_telescope_name=args_dict["simtel_telescope_name"],
+        schema_file=app_context.args["schema"],
+        simtel_config_file=app_context.args["simtel_cfg_file"],
+        simtel_telescope_name=app_context.args["simtel_telescope_name"],
     )
-    logger.info(f"Simtel parameter: {simtel_config_reader.parameter_dict}")
+    app_context.logger.info(f"Simtel parameter: {simtel_config_reader.parameter_dict}")
     if simtel_config_reader.parameter_dict is None or len(simtel_config_reader.parameter_dict) == 0:
-        logger.error("Parameter not found in sim_telarray configuration file.")
+        app_context.logger.error("Parameter not found in sim_telarray configuration file.")
         return
 
     simtel_config_reader.compare_simtel_config_with_schema()
 
     _json_dict = writer.ModelDataWriter.dump_model_parameter(
         parameter_name=simtel_config_reader.parameter_name,
-        value=simtel_config_reader.parameter_dict.get(args_dict["simtel_telescope_name"]),
-        instrument=args_dict["telescope"],
-        parameter_version=args_dict["parameter_version"],
-        output_file=args_dict["output_file"],
-        output_path=args_dict.get("output_path"),
-        use_plain_output_path=args_dict.get("use_plain_output_path"),
+        value=simtel_config_reader.parameter_dict.get(app_context.args["simtel_telescope_name"]),
+        instrument=app_context.args["telescope"],
+        parameter_version=app_context.args["parameter_version"],
+        output_file=app_context.args["output_file"],
+        output_path=app_context.args.get("output_path"),
     )
-    logger.info(f"Validated parameter: {_json_dict}")
+    app_context.logger.info(f"Validated parameter: {_json_dict}")
 
 
 if __name__ == "__main__":

simtools/applications/db_add_file_to_db.py

@@ -1,6 +1,6 @@
 #!/usr/bin/python3
 
-"""
+r"""
     Add a file to a DB.
 
     The name and location of the file are required.
@@ -37,21 +37,22 @@
 
 """
 
-import logging
 import uuid
 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.db import db_handler
 
 
 def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description="Add file to the DB.",
         usage="simtools-add-file-to-db --file_name test_application.dat --db test-data",
     )
-
     group = config.parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         "--file_name",
@@ -135,8 +136,8 @@ def confirm_and_insert_files(files_to_insert, args_dict, db, logger):
         Dictionary of parsed command-line arguments.
     db : DatabaseHandler
         Database handler object.
-    logger : logging.Logger
-        Logger object for logging messages.
+    logger : logging.logger
+        logger object for logging messages.
     """
     plural = "" if len(files_to_insert) == 1 else "s"
 
@@ -161,16 +162,14 @@ def confirm_and_insert_files(files_to_insert, args_dict, db, logger):
         db.db_client.drop_database(args_dict["db"])
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Add files to the database."""
+    app_context = startup_application(_parse, setup_io_handler=False)
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
 
-    files_to_insert = collect_files_to_insert(args_dict, logger, db)
-    confirm_and_insert_files(files_to_insert, args_dict, db, logger)
+    files_to_insert = collect_files_to_insert(app_context.args, app_context.logger, db)
+    confirm_and_insert_files(files_to_insert, app_context.args, db, app_context.logger)
 
 
 if __name__ == "__main__":

simtools/applications/db_add_simulation_model_from_repository_to_db.py

@@ -51,31 +51,19 @@ 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.db import db_handler, db_model_upload
 
 
-def _parse(label=None, description=None):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label : str
-        Label describing application.
-    description : str
-        Description of 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="Add or update a model parameter database to the DB",
+    )
     config.parser.add_argument(
         "--input_path",
         help="Path to simulation model repository.",
@@ -102,20 +90,19 @@ def _parse(label=None, description=None):
 
 
 def main():
-    """Application main."""
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(
-        label, description="Add or update a model parameter database to the DB"
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
-
-    if args_dict.get("type") == "model_parameters":
-        db_model_upload.add_model_parameters_to_db(input_path=Path(args_dict["input_path"]), db=db)
-    elif args_dict.get("type") == "production_tables":
-        db_model_upload.add_production_tables_to_db(input_path=Path(args_dict["input_path"]), db=db)
+    """Add or update a model parameter database to the DB."""
+    app_context = startup_application(_parse, setup_io_handler=False)
+
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
+
+    if app_context.args.get("type") == "model_parameters":
+        db_model_upload.add_model_parameters_to_db(
+            input_path=Path(app_context.args["input_path"]), db=db
+        )
+    elif app_context.args.get("type") == "production_tables":
+        db_model_upload.add_production_tables_to_db(
+            input_path=Path(app_context.args["input_path"]), db=db
+        )
 
 
 if __name__ == "__main__":