gammasimtools 0.6.0__py3-none-any.whl → 0.8.1__py3-none-any.whl

simtools/model/model_utils.py

@@ -1,45 +1,21 @@
 #!/usr/bin/python3
+"""Helper functions calculations related to model parameters."""
 
-import logging
 import math
 
 from simtools.utils import names
 
 __all__ = [
     "compute_telescope_transmission",
-    "get_telescope_class",
-    "get_camera_name",
     "is_two_mirror_telescope",
-    "split_simtel_parameter",
 ]
 
 
-def split_simtel_parameter(value):
-    """
-    Some array parameters are stored in sim_telarray model as string separated by comma or spaces.\
-    This functions turns this string into a list of floats. The delimiter is identified \
-    automatically.
-
-    Parameters
-    ----------
-    value: str
-        String with the array of floats separated by comma or spaces.
-
-    Returns
-    -------
-    list
-        Array of floats.
-    """
-
-    delimiter = "," if "," in value else " "
-    float_values = [float(v) for v in value.split(delimiter)]
-    return float_values
-
-
 def compute_telescope_transmission(pars, off_axis):
     """
-    Compute telescope transmission (0 < T < 1) for a given set of parameters as defined by \
-    the MC model and for a given off-axis angle.
+    Compute telescope transmission (0 < T < 1) for a given off-axis angle.
+
+    The telescope transmission depends on the MC model used.
 
     Parameters
     ----------
@@ -53,7 +29,6 @@ def compute_telescope_transmission(pars, off_axis):
     float
         Telescope transmission.
     """
-
     _deg_to_rad = math.pi / 180.0
     if pars[1] == 0:
         return pars[0]
@@ -62,71 +37,6 @@ def compute_telescope_transmission(pars, off_axis):
     return pars[0] / (1.0 + pars[2] * t ** pars[4])
 
 
-def get_camera_name(telescope_model_name):
-    """
-    Get camera name from the telescope name.
-
-    Parameters
-    ----------
-    telescope_model_name: str
-        Telescope model name (e.g., LST-1).
-
-    Returns
-    -------
-    str
-        Camera name (validated by util.names).
-    """
-
-    _logger = logging.getLogger(__name__)
-    camera_name = ""
-    tel_class, tel_type = names.split_telescope_model_name(telescope_model_name)
-    if tel_class == "LST":
-        camera_name = "LST"
-    elif tel_class == "MST":
-        if "FlashCam" in tel_type:
-            camera_name = "FlashCam"
-        elif "NectarCam" in tel_type:
-            camera_name = "NectarCam"
-        else:
-            _logger.error("Camera not found for MST class telescope")
-    elif tel_class == "SCT":
-        camera_name = "SCT"
-    elif tel_class == "SST":
-        if "ASTRI" in tel_type:
-            camera_name = "ASTRI"
-        elif "GCT" in tel_type:
-            camera_name = "GCT"
-        elif "1M" in tel_type:
-            camera_name = "1M"
-        else:
-            camera_name = "SST"
-    else:
-        _logger.error("Invalid telescope name - please validate it first")
-
-    camera_name = names.validate_camera_name(camera_name)
-    _logger.debug(f"Camera name - {camera_name}")
-    return camera_name
-
-
-def get_telescope_class(telescope_model_name):
-    """
-    Get telescope class from telescope name.
-
-    Parameters
-    ----------
-    telescope_model_name: str
-        Telescope model name (ex. LST-1).
-
-    Returns
-    -------
-    str
-        Telescope class (SST, MST, ...).
-    """
-
-    tel_class, _ = names.split_telescope_model_name(telescope_model_name)
-    return tel_class
-
-
 def is_two_mirror_telescope(telescope_model_name):
     """
     Check if the telescope is a two mirror design.
@@ -134,20 +44,14 @@ def is_two_mirror_telescope(telescope_model_name):
     Parameters
     ----------
     telescope_model_name: str
-        Telescope model name (ex. LST-1).
+        Telescope model name (ex. LSTN-01).
 
     Returns
     -------
     bool
         True if the telescope is a two mirror one.
     """
-    tel_class, tel_type = names.split_telescope_model_name(telescope_model_name)
-    if tel_class == "SST":
-        # Only 1M is False
-        return "1M" not in tel_type
-    if tel_class == "SCT":
-        # SCT always two mirrors
+    tel_type = names.get_array_element_type_from_name(telescope_model_name)
+    if "SST" in tel_type or "SCT" in tel_type:
         return True
-
-    # All MSTs and LSTs
     return False

simtools/model/site_model.py

@@ -0,0 +1,161 @@
+#!/usr/bin/python3
+"""Definition of site model."""
+
+import logging
+from pathlib import Path
+
+from simtools.model.model_parameter import ModelParameter
+
+__all__ = ["SiteModel"]
+
+
+class SiteModel(ModelParameter):
+    """
+    SiteModel represents the MC model of an observatory site.
+
+    Parameters
+    ----------
+    site: str
+        Site name (e.g., South or North).
+    mongo_db_config: dict
+        MongoDB configuration.
+    model_version: str
+        Model version.
+    label: str
+        Instance label. Important for output file naming.
+    """
+
+    def __init__(
+        self,
+        site: str,
+        mongo_db_config: dict,
+        model_version: str,
+        label: str | None = None,
+    ):
+        """Initialize SiteModel."""
+        self._logger = logging.getLogger(__name__)
+        self._logger.debug("Init SiteModel for site %s", site)
+        super().__init__(
+            site=site,
+            mongo_db_config=mongo_db_config,
+            model_version=model_version,
+            db=None,
+            label=label,
+        )
+
+    def get_reference_point(self) -> dict:
+        """
+        Get reference point coordinates as dict.
+
+        Returns
+        -------
+        dict
+            Reference point coordinates as dict
+        """
+        return {
+            "center_altitude": self.get_parameter_value_with_unit("reference_point_altitude"),
+            "center_northing": self.get_parameter_value_with_unit("reference_point_utm_north"),
+            "center_easting": self.get_parameter_value_with_unit("reference_point_utm_east"),
+            "epsg_code": self.get_parameter_value("epsg_code"),
+        }
+
+    def get_corsika_site_parameters(
+        self, config_file_style: bool = False, model_directory: Path | None = None
+    ) -> dict:
+        """
+        Get site-related CORSIKA parameters as dict.
+
+        Parameters are returned with units wherever possible.
+
+        Parameters
+        ----------
+        config_file_style: bool
+            Return using CORSIKA config file syntax
+        model_directory: Path, optional
+            Model directory to use for file paths
+
+        Returns
+        -------
+        dict
+            Site-related CORSIKA parameters as dict
+        """
+        if config_file_style:
+            model_directory = model_directory or Path("")
+            return {
+                "OBSLEV": [
+                    self.get_parameter_value_with_unit("corsika_observation_level").to_value("cm")
+                ],
+                # We always use a custom profile by filename, so this has to be set to 99
+                "ATMOSPHERE": [99, "Y"],
+                "IACT ATMOFILE": [
+                    model_directory / self.get_parameter_value("atmospheric_profile")
+                ],
+                "MAGNET": [
+                    self.get_parameter_value("geomag_horizontal"),
+                    self.get_parameter_value("geomag_vertical"),
+                ],
+                "ARRANG": [self.get_parameter_value("geomag_rotation")],
+            }
+
+        return {
+            "corsika_observation_level": self.get_parameter_value_with_unit(
+                "corsika_observation_level"
+            ),
+            "geomag_horizontal": self.get_parameter_value_with_unit("geomag_horizontal"),
+            "geomag_vertical": self.get_parameter_value_with_unit("geomag_vertical"),
+            "geomag_rotation": self.get_parameter_value_with_unit("geomag_rotation"),
+        }
+
+    def get_array_elements_for_layout(self, layout_name: str) -> list:
+        """
+        Return list of array elements for a given array layout.
+
+        Parameters
+        ----------
+        layout_name: str
+            Name of the array layout
+
+        Returns
+        -------
+        list
+            List of array elements
+        """
+        layouts = self.get_parameter_value("array_layouts")
+        for layout in layouts:
+            if layout["name"] == layout_name.lower():
+                return layout["elements"]
+        raise ValueError(f"Array layout '{layout_name}' not found in '{self.site}' site model.")
+
+    def get_list_of_array_layouts(self) -> list:
+        """
+        Get list of available array layouts.
+
+        Returns
+        -------
+        list
+            List of available array layouts
+        """
+        return [layout["name"] for layout in self.get_parameter_value("array_layouts")]
+
+    def export_atmospheric_transmission_file(self, model_directory: Path):
+        """
+        Export atmospheric transmission file.
+
+        This method is needed because when CORSIKA is not piped to sim_telarray,
+        the atmospheric transmission file is not written out to the model directory.
+        This method allows to export it explicitly.
+
+        Parameters
+        ----------
+        model_directory: Path
+            Model directory to export the file to.
+        """
+        self.db.export_model_files(
+            {
+                "atmospheric_transmission_file": {
+                    "value": self.get_parameter_value("atmospheric_profile"),
+                    "file": True,
+                }
+            },
+            model_directory,
+        )