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

simtools/applications/validate_camera_fov.py

@@ -47,19 +47,16 @@ 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.io import io_handler
 from simtools.model.telescope_model import TelescopeModel
 from simtools.visualization import plot_camera, visualize
 
 
 def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
-        label=Path(__file__).stem,
+        label=get_application_label(__file__),
         description=(
             "Calculate the camera FoV of the telescope requested. "
             "Plot the camera, as seen for an observer facing the camera."
@@ -86,51 +83,49 @@ def _parse():
     return config.initialize(db_config=True, simulation_model=["telescope", "model_version"])
 
 
-def main():  # noqa: D103
-    args_dict, db_config = _parse()
+def main():
+    """Validate camera field of view."""
+    app_context = startup_application(_parse)
 
     label = "validate_camera_fov"
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    _io_handler = io_handler.IOHandler()
-    output_dir = _io_handler.get_output_directory()
-
     tel_model = TelescopeModel(
-        site=args_dict["site"],
-        telescope_name=args_dict["telescope"],
-        mongo_db_config=db_config,
-        model_version=args_dict["model_version"],
+        site=app_context.args["site"],
+        telescope_name=app_context.args["telescope"],
+        mongo_db_config=app_context.db_config,
+        model_version=app_context.args["model_version"],
         label=label,
     )
     tel_model.export_model_files()
 
-    print(f"\nValidating the camera FoV of {tel_model.name}\n")
+    app_context.logger.info(f"\nValidating the camera FoV of {tel_model.name}\n")
 
     focal_length = tel_model.get_telescope_effective_focal_length("cm")
     camera = tel_model.camera
 
     fov, r_edge_avg = camera.calc_fov()
 
-    print("\nEffective focal length = " + f"{focal_length:.3f} cm")
-    print(f"{tel_model.name} FoV = {fov:.3f} deg")
-    print(f"Avg. edge radius = {r_edge_avg:.3f} cm\n")
+    app_context.logger.info(f"\nEffective focal length = {focal_length:.3f} cm")
+    app_context.logger.info(f"{tel_model.name} FoV = {fov:.3f} deg")
+    app_context.logger.info(f"Avg. edge radius = {r_edge_avg:.3f} cm\n")
 
     # Now plot the camera as well
     try:
-        pixel_ids_to_print = int(args_dict["print_pixels_id"])
+        pixel_ids_to_print = int(app_context.args["print_pixels_id"])
         if pixel_ids_to_print == 0:
             pixel_ids_to_print = -1  # so not print the zero pixel
     except ValueError as exc:
-        if args_dict["print_pixels_id"].lower() == "all":
+        if app_context.args["print_pixels_id"].lower() == "all":
             pixel_ids_to_print = camera.get_number_of_pixels()
         else:
             raise ValueError(
-                f"The value provided to --print_pixels_id ({args_dict['print_pixels_id']}) "
+                f"The value provided to --print_pixels_id ({app_context.args['print_pixels_id']}) "
                 "should be an integer or All"
             ) from exc
-    fig = plot_camera.plot_pixel_layout(camera, args_dict["camera_in_sky_coor"], pixel_ids_to_print)
+    fig = plot_camera.plot_pixel_layout(
+        camera, app_context.args["camera_in_sky_coor"], pixel_ids_to_print
+    )
+    output_dir = app_context.io_handler.get_output_directory()
     plot_file_prefix = output_dir.joinpath(f"{label}_{tel_model.name}_pixel_layout")
     visualize.save_figure(fig, f"{plot_file_prefix!s}", log_title="camera")
 

simtools/applications/validate_cumulative_psf.py

@@ -69,25 +69,24 @@
 
 """
 
-import logging
 from collections import OrderedDict
-from pathlib import Path
 
 import astropy.units as u
 import matplotlib.pyplot as plt
 import numpy as np
 
 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.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize
 
 
-def _parse(label):
+def _parse():
+    """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=(
             "Calculate and plot the PSF and eff. mirror area as a function of off-axis angle "
             "of the telescope requested."
@@ -125,54 +124,47 @@ def load_data(datafile):
     return data
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(label)
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    _io_handler = io_handler.IOHandler()
-    output_dir = _io_handler.get_output_directory()
+def main():
+    """Validate the cumulative PSF of a telescope model against data."""
+    app_context = startup_application(_parse)
 
     tel_model, site_model, _ = initialize_simulation_models(
-        label=label,
-        db_config=db_config,
-        site=args_dict["site"],
-        telescope_name=args_dict["telescope"],
-        model_version=args_dict["model_version"],
+        label=app_context.args.get("label"),
+        db_config=app_context.db_config,
+        site=app_context.args["site"],
+        telescope_name=app_context.args["telescope"],
+        model_version=app_context.args["model_version"],
     )
 
-    if args_dict.get("telescope_model_file"):
-        tel_model.change_multiple_parameters_from_file(args_dict["telescope_model_file"])
+    if app_context.args.get("telescope_model_file"):
+        tel_model.change_multiple_parameters_from_file(app_context.args["telescope_model_file"])
 
     ray = RayTracing(
         telescope_model=tel_model,
         site_model=site_model,
-        simtel_path=args_dict["simtel_path"],
-        zenith_angle=args_dict["zenith"] * u.deg,
-        source_distance=args_dict["src_distance"] * u.km,
+        simtel_path=app_context.args["simtel_path"],
+        zenith_angle=app_context.args["zenith"] * u.deg,
+        source_distance=app_context.args["src_distance"] * u.km,
         off_axis_angle=[0.0] * u.deg,
     )
 
-    ray.simulate(test=args_dict["test"], force=False)
+    ray.simulate(test=app_context.args["test"], force=False)
     ray.analyze(force=False)
 
     # Plotting cumulative PSF
     im = ray.images()[0]
 
-    print(f"d80 in cm = {im.get_psf()}")
+    app_context.logger.info(f"d80 in cm = {im.get_psf()}")
 
-    # Plotting cumulative PSF
-    # Measured cumulative PSF
+    # Plotting measured cumulative PSF
     data_to_plot = OrderedDict()
     radius = None
-    if args_dict.get("data", None):
-        data_file = gen.find_file(args_dict["data"], args_dict["model_path"])
+    if app_context.args.get("data", None):
+        data_file = gen.find_file(app_context.args["data"], app_context.args["model_path"])
         data_to_plot["measured"] = load_data(data_file)
         radius = data_to_plot["measured"]["Radius [cm]"]
 
-    # Simulated cumulative PSF
+    # Plotting simulated cumulative PSF
     if radius is not None:
         data_to_plot[r"sim$\_$telarray"] = im.get_cumulative_data(radius * u.cm)
     else:
@@ -181,8 +173,8 @@ def main():  # noqa: D103
     fig = visualize.plot_1d(data_to_plot)
     fig.gca().set_ylim(0, 1.05)
 
-    plot_file_name = label + "_" + tel_model.name + "_cumulative_PSF"
-    plot_file = output_dir.joinpath(plot_file_name)
+    plot_file_name = app_context.args.get("label") + "_" + tel_model.name + "_cumulative_PSF"
+    plot_file = app_context.io_handler.get_output_file(plot_file_name)
     visualize.save_figure(fig, plot_file)
 
     # Plotting image
@@ -192,8 +184,8 @@ def main():  # noqa: D103
     fig.gca().add_artist(circle)
     fig.gca().set_aspect("equal")
 
-    plot_file_name = label + "_" + tel_model.name + "_image"
-    plot_file = output_dir.joinpath(plot_file_name)
+    plot_file_name = app_context.args.get("label") + "_" + tel_model.name + "_image"
+    plot_file = app_context.io_handler.get_output_file(plot_file_name)
     visualize.save_figure(fig, plot_file)
 
 

simtools/applications/validate_file_using_schema.py

@@ -32,35 +32,22 @@ r"""
 
 """
 
-import logging
 import re
 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 MODEL_PARAMETER_SCHEMA_PATH
 from simtools.data_model import metadata_collector, schema, validate_data
 from simtools.io import ascii_handler
 
 
-def _parse(label, description):
-    """
-    Parse command line configuration.
-
-    Parameters
-    ----------
-    label (str)
-        application label
-    description (str)
-        application description
-
-    Returns
-    -------
-    config (Configurator)
-        application configuration
-
-    """
-    config = configurator.Configurator(label=label, description=description)
+def _parse():
+    """Parse command line configuration."""
+    config = configurator.Configurator(
+        label=get_application_label(__file__),
+        description="Validate a file (metadata, schema, or data file) using a schema.",
+    )
     config.parser.add_argument(
         "--file_name",
         help="File to be validated (full path or name pattern, e.g., '*.json')",
@@ -200,21 +187,16 @@ def validate_metadata(args_dict, logger):
     logger.info(f"Successful validation of metadata {args_dict['file_name']}")
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, _ = _parse(
-        label, description="Validate a file (metadata, schema, or data file) using a schema."
-    )
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+def main():
+    """Validate a file or files in a directory using a schema."""
+    app_context = startup_application(_parse)
 
-    if args_dict["data_type"].lower() == "metadata":
-        validate_metadata(args_dict, logger)
-    elif args_dict["data_type"].lower() == "schema":
-        validate_dict_using_schema(args_dict, logger)
+    if app_context.args["data_type"].lower() == "metadata":
+        validate_metadata(app_context.args, app_context.logger)
+    elif app_context.args["data_type"].lower() == "schema":
+        validate_dict_using_schema(app_context.args, app_context.logger)
     else:
-        validate_data_files(args_dict, logger)
+        validate_data_files(app_context.args, app_context.logger)
 
 
 if __name__ == "__main__":

simtools/applications/validate_optics.py

@@ -65,7 +65,6 @@ r"""
 
 """
 
-import logging
 from pathlib import Path
 
 import astropy.units as u
@@ -73,18 +72,17 @@ import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib.backends.backend_pdf import PdfPages
 
-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.model.model_utils import initialize_simulation_models
 from simtools.ray_tracing.ray_tracing import RayTracing
 from simtools.visualization import visualize
 
 
-def _parse(label):
+def _parse():
     """Parse command line configuration."""
     config = configurator.Configurator(
-        label=label,
+        label=get_application_label(__file__),
         description=(
             "Calculate and plot the PSF and effective mirror area as a function of off-axis angle "
             "of the telescope requested."
@@ -118,22 +116,16 @@ def _parse(label):
     return config.initialize(db_config=True, simulation_model=["telescope", "model_version"])
 
 
-def main():  # noqa: D103
-    label = Path(__file__).stem
-    args_dict, db_config = _parse(label)
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    _io_handler = io_handler.IOHandler()
-    output_dir = _io_handler.get_output_directory()
+def main():
+    """Validate the optical model parameters through ray tracing simulations."""
+    app_context = startup_application(_parse, setup_io_handler=True)
 
     tel_model, site_model, _ = initialize_simulation_models(
-        label=label,
-        db_config=db_config,
-        site=args_dict["site"],
-        telescope_name=args_dict["telescope"],
-        model_version=args_dict["model_version"],
+        label=Path(__file__).stem,
+        db_config=app_context.db_config,
+        site=app_context.args["site"],
+        telescope_name=app_context.args["telescope"],
+        model_version=app_context.args["model_version"],
     )
 
     ######################################################################
@@ -147,22 +139,24 @@ def main():  # noqa: D103
     # }
     # tel_model.change_multiple_parameters(**pars_to_change)
 
-    print(f"\nValidating telescope optics with ray tracing simulations for {tel_model.name}\n")
+    app_context.logger.info(
+        f"\nValidating telescope optics with ray tracing simulations for {tel_model.name}\n"
+    )
 
     ray = RayTracing(
         telescope_model=tel_model,
         site_model=site_model,
-        simtel_path=args_dict["simtel_path"],
-        zenith_angle=args_dict["zenith"] * u.deg,
-        source_distance=args_dict["src_distance"] * u.km,
+        simtel_path=app_context.args["simtel_path"],
+        zenith_angle=app_context.args["zenith"] * u.deg,
+        source_distance=app_context.args["src_distance"] * u.km,
         off_axis_angle=np.linspace(
             0,
-            args_dict["max_offset"],
-            int(args_dict["max_offset"] / args_dict["offset_steps"]) + 1,
+            app_context.args["max_offset"],
+            int(app_context.args["max_offset"] / app_context.args["offset_steps"]) + 1,
         )
         * u.deg,
     )
-    ray.simulate(test=args_dict["test"], force=False)
+    ray.simulate(test=app_context.args["test"], force=False)
     ray.analyze(force=True)
 
     # Plotting
@@ -171,17 +165,17 @@ def main():  # noqa: D103
 
         ray.plot(key, marker="o", linestyle=":", color="k")
 
-        plot_file_name = "_".join((label, tel_model.name, key))
-        plot_file = output_dir.joinpath(plot_file_name)
+        plot_file_name = "_".join((app_context.args.get("label"), tel_model.name, key))
+        plot_file = app_context.io_handler.get_output_file(plot_file_name)
         visualize.save_figure(plt, plot_file)
 
     # Plotting images
-    if args_dict["plot_images"]:
-        plot_file_name = "_".join((label, tel_model.name, "images.pdf"))
-        plot_file = output_dir.joinpath(plot_file_name)
+    if app_context.args["plot_images"]:
+        plot_file_name = "_".join((app_context.args.get("label"), tel_model.name, "images.pdf"))
+        plot_file = app_context.io_handler.get_output_file(plot_file_name)
         pdf_pages = PdfPages(plot_file)
 
-        logger.info(f"Plotting images into {plot_file}")
+        app_context.logger.info(f"Plotting images into {plot_file}")
 
         for image in ray.images():
             fig = plt.figure(figsize=(8, 6), tight_layout=True)

simtools/camera/camera_efficiency.py

@@ -15,8 +15,6 @@ from simtools.simtel.simulator_camera_efficiency import SimulatorCameraEfficienc
 from simtools.utils import names
 from simtools.visualization import visualize
 
-__all__ = ["CameraEfficiency"]
-
 
 class CameraEfficiency:
     """

simtools/configuration/commandline_parser.py

@@ -10,10 +10,6 @@ import astropy.units as u
 import simtools.version
 from simtools.utils import names
 
-__all__ = [
-    "CommandLineParser",
-]
-
 
 class CommandLineParser(argparse.ArgumentParser):
     """
@@ -561,6 +557,38 @@ class CommandLineParser(argparse.ArgumentParser):
         )
         return job_group
 
+    @staticmethod
+    def scientific_int(value):
+        """
+        Convert string (including scientific notation) to integer.
+
+        Parameters
+        ----------
+        value: str or int or float
+            Value to convert to integer. Can be a regular integer,
+            float, or string in scientific notation (e.g., '1e7').
+
+        Returns
+        -------
+        int
+            Converted integer value
+
+        Raises
+        ------
+        argparse.ArgumentTypeError
+            If the value cannot be converted to an integer
+        """
+        try:
+            f = float(value)
+            if not f.is_integer():
+                raise ValueError
+            return int(f)
+        except (ValueError, TypeError) as exc:
+            raise argparse.ArgumentTypeError(
+                f"Invalid integer value: '{value}'. "
+                "Expected an integer or scientific notation like '1e7'."
+            ) from exc
+
     @staticmethod
     def site(value):
         """

simtools/configuration/configurator.py

@@ -14,11 +14,6 @@ from simtools.db.db_handler import jsonschema_db_dict
 from simtools.io import ascii_handler, io_handler
 from simtools.utils import general as gen
 
-__all__ = [
-    "Configurator",
-    "InvalidConfigurationParameterError",
-]
-
 
 class InvalidConfigurationParameterError(Exception):
     """Exception for Invalid configuration parameter."""

simtools/corsika/corsika_config.py

@@ -10,11 +10,6 @@ from simtools.corsika.primary_particle import PrimaryParticle
 from simtools.io import io_handler
 from simtools.model.model_parameter import ModelParameter
 
-__all__ = [
-    "CorsikaConfig",
-    "InvalidCorsikaInputError",
-]
-
 
 class InvalidCorsikaInputError(Exception):
     """Exception for invalid corsika input."""

simtools/data_model/data_reader.py

@@ -10,8 +10,6 @@ from simtools.data_model import validate_data
 from simtools.data_model.metadata_collector import MetadataCollector
 from simtools.io import ascii_handler
 
-__all__ = ["read_table_from_file", "read_value_from_file"]
-
 _logger = logging.getLogger(__name__)
 
 

simtools/data_model/metadata_collector.py

@@ -18,8 +18,6 @@ from simtools.data_model import metadata_model, schema
 from simtools.io import ascii_handler, io_handler
 from simtools.utils import names
 
-__all__ = ["MetadataCollector"]
-
 
 class MetadataCollector:
     """

simtools/data_model/model_data_writer.py

@@ -13,8 +13,6 @@ from simtools.db import db_handler
 from simtools.io import ascii_handler, io_handler
 from simtools.utils import names, value_conversion
 
-__all__ = ["ModelDataWriter"]
-
 
 class ModelDataWriter:
     """

simtools/data_model/validate_data.py

@@ -15,8 +15,6 @@ from simtools.data_model import schema
 from simtools.io import ascii_handler
 from simtools.utils import names, value_conversion
 
-__all__ = ["DataValidator"]
-
 
 class DataValidator:
     """

simtools/db/db_handler.py

@@ -19,8 +19,6 @@ from simtools.simtel import simtel_table_reader
 from simtools.utils import names, value_conversion
 from simtools.version import resolve_version_to_latest_patch
 
-__all__ = ["DatabaseHandler"]
-
 logging.getLogger("pymongo").setLevel(logging.WARNING)
 
 

simtools/io/hdf5_handler.py

@@ -10,11 +10,6 @@ from ctapipe.io import read_table
 
 from simtools.utils.names import sanitize_name
 
-__all__ = [
-    "fill_hdf5_table",
-    "read_hdf5",
-]
-
 _logger = logging.getLogger(__name__)
 
 

simtools/io/legacy_data_handler.py

@@ -5,11 +5,6 @@ import logging
 
 from astropy.table import Table
 
-__all__ = [
-    "read_legacy_data_as_table",
-    "read_legacy_lst_single_pe",
-]
-
 logger = logging.getLogger(__name__)
 
 

simtools/job_execution/job_manager.py

@@ -7,9 +7,6 @@ from pathlib import Path
 
 import simtools.utils.general as gen
 
-__all__ = ["JobExecutionError", "JobManager"]
-
-
 logger = logging.getLogger(__name__)
 
 

simtools/layout/array_layout.py

@@ -17,8 +17,6 @@ from simtools.model.site_model import SiteModel
 from simtools.model.telescope_model import TelescopeModel
 from simtools.utils import names, value_conversion
 
-__all__ = ["ArrayLayout", "InvalidTelescopeListFileError"]
-
 
 class InvalidTelescopeListFileError(Exception):
     """Exception for invalid telescope list file."""

simtools/layout/telescope_position.py

@@ -6,8 +6,6 @@ import astropy.units as u
 import numpy as np
 import pyproj
 
-__all__ = ["InvalidCoordSystemErrorError", "TelescopePosition"]
-
 
 class InvalidCoordSystemErrorError(Exception):
     """Exception for invalid coordinate system."""

simtools/model/array_model.py

@@ -15,8 +15,6 @@ from simtools.model.telescope_model import TelescopeModel
 from simtools.simtel.simtel_config_writer import SimtelConfigWriter
 from simtools.utils import general, names
 
-__all__ = ["ArrayModel"]
-
 
 class ArrayModel:
     """
@@ -367,8 +365,8 @@ class ArrayModel:
             self._logger.warning("No model files found to pack.")
             return None
 
-        archive_name = self.get_config_directory() / "model_files.tar.gz"
-        general.pack_tar_file(archive_name, model_files)
+        archive_name = self.get_config_directory() / f"model_files_{self.model_version}.tar.gz"
+        general.pack_tar_file(archive_name, model_files, sub_dir=f"model/{self.model_version}")
         self._logger.info(f"Packed model files into {archive_name}")
         return archive_name
 

simtools/model/calibration_model.py

@@ -4,8 +4,6 @@ import logging
 
 from simtools.model.model_parameter import ModelParameter
 
-__all__ = ["CalibrationModel"]
-
 
 class CalibrationModel(ModelParameter):
     """

simtools/model/camera.py

@@ -8,8 +8,6 @@ import numpy as np
 
 from simtools.utils.geometry import rotate
 
-__all__ = ["Camera"]
-
 
 class Camera:
     """

simtools/model/mirrors.py

@@ -8,8 +8,6 @@ import astropy.units as u
 import numpy as np
 from astropy.table import Table
 
-__all__ = ["InvalidMirrorListFileError", "Mirrors"]
-
 
 class InvalidMirrorListFileError(Exception):
     """Exception for invalid mirror list file."""