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

simtools/applications/db_development_tools/write_array_elements_positions_to_repository.py

@@ -33,35 +33,23 @@
 
 """
 
-import logging
 from pathlib import Path
 
 import astropy.table
 
-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.model_data_writer import ModelDataWriter
 from simtools.io import ascii_handler
 from simtools.model.array_model import ArrayModel
 
 
-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 array element positions to model parameter repository",
+    )
     config.parser.add_argument(
         "--input",
         help="File containing a table of array element positions.",
@@ -96,8 +84,8 @@ def write_utm_array_elements_to_repository(args_dict, logger):
     ----------
     args_dict : dict
         Command line arguments.
-    logger : Logger
-        Logger object.
+    app_context.logger : app_context.logger
+        app_context.logger object.
 
     """
     array_elements = astropy.table.Table.read(args_dict["input"])
@@ -131,8 +119,8 @@ def write_ground_array_elements_to_repository(args_dict, db_config, logger):
         Command line arguments.
     db_config : dict
         Database configuration.
-    logger : Logger
-        Logger object.
+    logger : logger
+        logger object.
 
     """
     array_model = ArrayModel(
@@ -155,19 +143,16 @@ def write_ground_array_elements_to_repository(args_dict, db_config, logger):
 
 def main():
     """Application main."""
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(
-        label, description="Add array element positions to model parameter repository"
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    app_context = startup_application(_parse)
 
-    if args_dict["coordinate_system"] == "utm":
-        write_utm_array_elements_to_repository(args_dict, logger)
-    elif args_dict["coordinate_system"] == "ground":
-        write_ground_array_elements_to_repository(args_dict, db_config, logger)
+    if app_context.args["coordinate_system"] == "utm":
+        write_utm_array_elements_to_repository(app_context.args, app_context.logger)
+    elif app_context.args["coordinate_system"] == "ground":
+        write_ground_array_elements_to_repository(
+            app_context.args, app_context.db_config, app_context.logger
+        )
     else:
-        logger.error("Invalid coordinate system. Allowed are 'utm' and 'ground'.")
+        app_context.logger.error("Invalid coordinate system. Allowed are 'utm' and 'ground'.")
         raise ValueError
 
 

simtools/applications/db_generate_compound_indexes.py

@@ -13,16 +13,16 @@ db_name (str, optional)
     Database name (use "all" for all databases)
 """
 
-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.db import db_handler
 
 
 def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
-        description="Generate compound indexes for a specific database"
+        description="Generate compound indexes for a specific database",
+        label=get_application_label(__file__),
     )
     config.parser.add_argument(
         "--db_name",
@@ -33,18 +33,16 @@ def _parse():
     return config.initialize(db_config=True)
 
 
-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():
+    """Generate compound indexes for the specified 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)
 
     db.generate_compound_indexes_for_databases(
-        db_name=args_dict["db_name"],
-        db_simulation_model=args_dict.get("db_simulation_model"),
-        db_simulation_model_version=args_dict.get("db_simulation_model_version"),
+        db_name=app_context.args["db_name"],
+        db_simulation_model=app_context.args.get("db_simulation_model"),
+        db_simulation_model_version=app_context.args.get("db_simulation_model_version"),
     )
 
 

simtools/applications/db_get_array_layouts_from_db.py

@@ -51,33 +51,19 @@ Retrieve telescope positions from database (utm coordinate system) and write to
       --output_file telescope_positions-test_layout.ecsv
 """
 
-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.model.array_model import ArrayModel
 from simtools.model.site_model import SiteModel
 
 
-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="Get list of array elements as defined in the db (array layout).",
+    )
 
     input_group = config.parser.add_mutually_exclusive_group()
     input_group.add_argument(
@@ -128,33 +114,27 @@ def _layout_from_db(args_dict, db_config):
 
 
 def main():
-    """Get list of array elements as defined in the db (array layout)."""
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(
-        label,
-        "Get list of array elements as defined in the db (array layout).",
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    """Get list of array layouts or list of elements for a given layout as defined in the db."""
+    app_context = startup_application(_parse)
 
-    if args_dict.get("list_available_layouts", False):
-        if args_dict.get("site", None) is None:
+    if app_context.args.get("list_available_layouts", False):
+        if app_context.args.get("site", None) is None:
             raise ValueError("Site must be provided to list available layouts.")
         site_model = SiteModel(
-            mongo_db_config=db_config,
-            model_version=args_dict["model_version"],
-            site=args_dict["site"],
+            mongo_db_config=app_context.db_config,
+            model_version=app_context.args["model_version"],
+            site=app_context.args["site"],
         )
         print(site_model.get_list_of_array_layouts())
     else:
-        logger.info("Array layout: %s", args_dict["array_layout_name"])
-        layout = _layout_from_db(args_dict, db_config)
+        app_context.logger.info("Array layout: %s", app_context.args["array_layout_name"])
+        layout = _layout_from_db(app_context.args, app_context.db_config)
         layout.pprint()
 
-        if not args_dict.get("output_file_from_default", False):
+        if not app_context.args.get("output_file_from_default", False):
             writer.ModelDataWriter.dump(
-                args_dict=args_dict,
-                output_file=args_dict["output_file"],
+                args_dict=app_context.args,
+                output_file=app_context.args["output_file"],
                 metadata=None,
                 product_data=layout,
             )

simtools/applications/db_get_file_from_db.py

@@ -33,16 +33,15 @@
 
 """
 
-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.db import db_handler
-from simtools.io import io_handler
 
 
 def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description="Get file(s) from the DB.",
         usage="simtools-get-file-from-db --file_name mirror_CTA-S-LST_v2020-04-07.dat",
     )
@@ -57,24 +56,23 @@ def _parse():
     return config.initialize(db_config=True, output=True)
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse()
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-    _io_handler = io_handler.IOHandler()
+def main():
+    """Get file from database."""
+    app_context = startup_application(_parse)
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
     file_id = db.export_model_files(
-        dest=_io_handler.get_output_directory(),
-        file_names=args_dict["file_name"],
+        dest=app_context.io_handler.get_output_directory(),
+        file_names=app_context.args["file_name"],
     )
     if file_id is None:
-        logger.error(f"The file {args_dict['file_name']} was not found in {db.db_name}.")
+        app_context.logger.error(
+            f"The file {app_context.args['file_name']} was not found in {db.db_name}."
+        )
         raise FileNotFoundError
-    logger.info(
-        f"Got file {args_dict['file_name']} from DB {db.db_name} "
-        f"and saved into {_io_handler.get_output_directory()}"
+    app_context.logger.info(
+        f"Got file {app_context.args['file_name']} from DB {db.db_name} "
+        f"and saved into {app_context.io_handler.get_output_directory()}"
     )
 
 

simtools/applications/db_get_parameter_from_db.py

@@ -60,23 +60,23 @@ r"""
 
 """
 
-import logging
-from pathlib import Path
 from pprint import pprint
 
-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
-from simtools.io import ascii_handler, io_handler
+from simtools.io import ascii_handler
 
 
 def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
+        label=get_application_label(__file__),
         description=(
             "Get a parameter entry from DB for a specific telescope or a site. "
             "The application receives a parameter name, a site, a telescope (if applicable), "
             "and a version. It then prints out the parameter entry. "
-        )
+        ),
     )
 
     config.parser.add_argument("--parameter", help="Parameter name", type=str, required=True)
@@ -104,48 +104,46 @@ def _parse():
     )
 
 
-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():
+    """Get a parameter entry from DB for a specific telescope or a site."""
+    app_context = startup_application(_parse)
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
 
     pars = db.get_model_parameter(
-        parameter=args_dict["parameter"],
-        site=args_dict["site"],
-        array_element_name=args_dict.get("telescope"),
-        parameter_version=args_dict.get("parameter_version"),
-        model_version=args_dict.get("model_version"),
+        parameter=app_context.args["parameter"],
+        site=app_context.args["site"],
+        array_element_name=app_context.args.get("telescope"),
+        parameter_version=app_context.args.get("parameter_version"),
+        model_version=app_context.args.get("model_version"),
     )
-    if args_dict["export_model_file"] or args_dict["export_model_file_as_table"]:
+    if app_context.args["export_model_file"] or app_context.args["export_model_file_as_table"]:
         table = db.export_model_file(
-            parameter=args_dict["parameter"],
-            site=args_dict["site"],
-            array_element_name=args_dict["telescope"],
-            parameter_version=args_dict.get("parameter_version"),
-            model_version=args_dict.get("model_version"),
-            export_file_as_table=args_dict["export_model_file_as_table"],
+            parameter=app_context.args["parameter"],
+            site=app_context.args["site"],
+            array_element_name=app_context.args["telescope"],
+            parameter_version=app_context.args.get("parameter_version"),
+            model_version=app_context.args.get("model_version"),
+            export_file_as_table=app_context.args["export_model_file_as_table"],
         )
-        param_value = pars[args_dict["parameter"]]["value"]
-        table_file = Path(io_handler.IOHandler().get_output_directory()) / f"{param_value}"
-        logger.info(f"Exported model file {param_value} to {table_file}")
+        param_value = pars[app_context.args["parameter"]]["value"]
+        table_file = app_context.io_handler.get_output_file(param_value)
+        app_context.logger.info(f"Exported model file {param_value} to {table_file}")
         if table and table_file.suffix != ".ecsv":
             table.write(table_file.with_suffix(".ecsv"), format="ascii.ecsv", overwrite=True)
-            logger.info(f"Exported model file {param_value} to {table_file.with_suffix('.ecsv')}")
+            app_context.logger.info(
+                f"Exported model file {param_value} to {table_file.with_suffix('.ecsv')}"
+            )
 
-    if args_dict["output_file"] is not None:
-        _output_file = (
-            Path(io_handler.IOHandler().get_output_directory()) / args_dict["output_file"]
-        )
-        pars[args_dict["parameter"]].pop("_id")
-        pars[args_dict["parameter"]].pop("entry_date")
+    if app_context.args["output_file"] is not None:
+        pars[app_context.args["parameter"]].pop("_id")
+        pars[app_context.args["parameter"]].pop("entry_date")
         ascii_handler.write_data_to_file(
-            data=pars[args_dict["parameter"]], output_file=_output_file
+            data=pars[app_context.args["parameter"]],
+            output_file=app_context.io_handler.get_output_file(app_context.args["output_file"]),
         )
     else:
-        pprint(pars[args_dict["parameter"]])
+        pprint(pars[app_context.args["parameter"]])
 
 
 if __name__ == "__main__":

simtools/applications/db_inspect_databases.py

@@ -9,15 +9,16 @@ db_name (str, optional)
     Database name (use "all" for all databases)
 """
 
-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.db import db_handler
 
 
 def _parse():
-    config = configurator.Configurator(description="Inspect databases")
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__), description="Inspect databases"
+    )
     config.parser.add_argument(
         "--db_name",
         help="Database name",
@@ -27,18 +28,16 @@ def _parse():
     return config.initialize(db_config=True)
 
 
-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():
+    """Inspect databases."""
+    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)
     # databases without internal databases we don't have rights to modify
     databases = [
         d for d in db.db_client.list_database_names() if d not in ("config", "admin", "local")
     ]
-    requested = args_dict["db_name"]
+    requested = app_context.args["db_name"]
     if requested != "all" and requested not in databases:
         raise ValueError(
             f"Requested database '{requested}' not found. "

simtools/applications/db_upload_model_repository.py

@@ -40,10 +40,7 @@ used to name the database, but no tag checkout is done):
 
 """
 
-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
 
@@ -53,23 +50,12 @@ DEFAULT_REPOSITORY_URL = (
 )
 
 
-def _parse(label=None, description=None):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label : str
-        Label describing application.
-    description : str
-        Description of application.
-
-    Returns
-    -------
-    tuple
-        Command line parser object and database configuration.
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Upload model parameters from repository to database",
+    )
     config.parser.add_argument(
         "--branch",
         help="Repository branch to clone (optional, defaults to using version tag).",
@@ -99,22 +85,18 @@ def _parse(label=None, description=None):
 
 def main():
     """Application main."""
-    args_dict, db_config = _parse(
-        label=Path(__file__).stem, description="Upload model parameters from repository to database"
-    )
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    app_context = startup_application(_parse)
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
     db.print_connection_info()
 
     db_model_upload.add_complete_model(
-        tmp_dir=args_dict.get("tmp_dir"),
+        tmp_dir=app_context.args.get("tmp_dir"),
         db=db,
-        db_simulation_model=args_dict.get("db_simulation_model"),
-        db_simulation_model_version=args_dict.get("db_simulation_model_version"),
+        db_simulation_model=app_context.args.get("db_simulation_model"),
+        db_simulation_model_version=app_context.args.get("db_simulation_model_version"),
         repository_url=DEFAULT_REPOSITORY_URL,
-        repository_branch=args_dict.get("branch"),
+        repository_branch=app_context.args.get("branch"),
     )
 
 

simtools/applications/derive_ctao_array_layouts.py

@@ -42,10 +42,7 @@ r"""
             --updated_parameter_version 3.0.0
 """
 
-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
 from simtools.layout.array_layout_utils import (
@@ -55,10 +52,10 @@ from simtools.layout.array_layout_utils import (
 )
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description="Derive CTAO array layouts from CTAO common identifiers repository.",
     )
     config.parser.add_argument(
@@ -85,34 +82,32 @@ def _parse(label):
     )
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse(Path(__file__).stem)
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Derive CTAO array layouts from CTAO common identifiers repository."""
+    app_context = startup_application(_parse)
 
     ctao_array_layouts = retrieve_ctao_array_layouts(
-        site=args_dict["site"],
-        repository_url=args_dict["repository_url"],
-        branch_name=args_dict["repository_branch"],
+        site=app_context.args["site"],
+        repository_url=app_context.args["repository_url"],
+        branch_name=app_context.args["repository_branch"],
     )
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db = db_handler.DatabaseHandler(mongo_db_config=app_context.db_config)
     db_array_layouts = db.get_model_parameter(
         parameter="array_layouts",
-        site=args_dict["site"],
+        site=app_context.args["site"],
         array_element_name=None,
-        parameter_version=args_dict.get("parameter_version"),
-        model_version=args_dict.get("model_version"),
+        parameter_version=app_context.args.get("parameter_version"),
+        model_version=app_context.args.get("model_version"),
     )
     db_array_layouts["array_layouts"].pop("_id", None)
     db_array_layouts["array_layouts"].pop("entry_date", None)
-    logger.info(f"Layouts from model parameter database: {db_array_layouts}")
+    app_context.logger.info(f"Layouts from model parameter database: {db_array_layouts}")
 
     write_array_layouts(
         array_layouts=merge_array_layouts(db_array_layouts["array_layouts"], ctao_array_layouts),
-        args_dict=args_dict,
-        db_config=db_config,
+        args_dict=app_context.args,
+        db_config=app_context.db_config,
     )
 
 

simtools/applications/derive_mirror_rnda.py

@@ -125,18 +125,15 @@ 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.ray_tracing.mirror_panel_psf import MirrorPanelPSF
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        description="Derive mirror random reflection angle.", label=label
+        description="Derive mirror random reflection angle.", label=get_application_label(__file__)
     )
     psf_group = config.parser.add_mutually_exclusive_group()
     psf_group.add_argument(
@@ -217,15 +214,13 @@ def _parse(label):
     )
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-
-    args_dict, db_config = _parse(label)
+def main():
+    """Derive mirror random reflection angle of a single mirror panel."""
+    app_context = startup_application(_parse)
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    panel_psf = MirrorPanelPSF(label, args_dict, db_config)
+    panel_psf = MirrorPanelPSF(
+        app_context.args.get("label"), app_context.args, app_context.db_config
+    )
     panel_psf.derive_random_reflection_angle(save_figures=True)
     panel_psf.print_results()
     panel_psf.write_optimization_data()

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()