Improve reading of design models; refactoring and improved docstrings for simtools.utils.names

docs/changes/1390.maintenance.md

@@ -0,0 +1 @@
+Improve function naming and unit test coverage in `simtools.utils.names`.

docs/changes/1396.maintenance.md

@@ -0,0 +1 @@
+Improve reading of design models; refactoring and improved docstrings for `simtools.utils.names`.

src/simtools/applications/generate_regular_arrays.py

@@ -77,7 +77,9 @@ def main():
         # Single telescope at the center
         if array_name[0] == "1":
             tel_name.append(
-                names.get_array_element_name_from_type_site_id(tel_size, args_dict["site"], "01")
+                names.generate_array_element_name_from_type_site_id(
+                    tel_size, args_dict["site"], "01"
+                )
             )
             pos_x.append(0 * u.m)
             pos_y.append(0 * u.m)
@@ -86,7 +88,7 @@ def main():
         else:
             for i in range(1, 5):
                 tel_name.append(
-                    names.get_array_element_name_from_type_site_id(
+                    names.generate_array_element_name_from_type_site_id(
                         tel_size, args_dict["site"], f"0{i}"
                     )
                 )

src/simtools/db/db_handler.py

@@ -862,15 +862,20 @@
             return ["xSTx-design"]  # placeholder to ignore 'instrument' field in query.
         if collection == "sites":
             return [f"OBS-{site}"]
-        if "-design" in array_element_name:
+        if names.is_design_type(array_element_name):
             return [array_element_name]
+        if collection == "configuration_sim_telarray":
+            # get design model from 'telescope' or 'calibration_device' production tables
+            production_table = self._read_production_table_from_mongo_db(
+                names.get_collection_name_from_array_element_name(array_element_name),
+                production_table["model_version"],
+            )
         try:
             return [
                 production_table["design_model"][array_element_name],
                 array_element_name,
             ]
-        except KeyError:
-            return [
-                names.guess_design_model_from_name(array_element_name),
-                array_element_name,
-            ]
+        except KeyError as exc:
+            raise KeyError(
+                f"Failed generated array element list for db query for {array_element_name}"
+            ) from exc

src/simtools/layout/array_layout.py

@@ -445,9 +445,11 @@
             )
             try:
                 tel_model = self._get_telescope_model(telescope_name)
-            except ValueError:
+            except ValueError:  # telescope not found in the database revert to design model
                 tel_model = self._get_telescope_model(
-                    names.guess_design_model_from_name(telescope_name),
+                    names.array_element_design_types(
+                        names.get_array_element_type_from_name(telescope_name)
+                    )[0]
                 )
 
             for para in ("telescope_axis_height", "telescope_sphere_radius"):

src/simtools/reporting/docs_read_parameters.py

@@ -77,8 +77,8 @@ def get_all_parameter_descriptions(self):
         """
         parameter_description, short_description, inst_class = {}, {}, {}
 
-        for instrument_class in names.instrument_classes("telescope"):
-            for parameter, details in names.load_model_parameters(instrument_class).items():
+        for instrument_class in names.db_collection_to_instrument_class_key("telescopes"):
+            for parameter, details in names.model_parameters(instrument_class).items():
                 parameter_description[parameter] = details.get("description")
                 short_description[parameter] = details.get("short_description")
                 inst_class[parameter] = instrument_class

src/simtools/schemas/array_elements.yml

@@ -15,6 +15,7 @@ data:
     collection: "telescopes"
     observatory: "CTAO"
     site: "North"
+    design_types: ["FlashCam", "NectarCam", "test"]
   LSTS:
     collection: "telescopes"
     observatory: "CTAO"
@@ -23,6 +24,7 @@ data:
     collection: "telescopes"
     observatory: "CTAO"
     site: "South"
+    design_types: ["FlashCam", "NectarCam", "test"]
   SSTS:
     collection: "telescopes"
     observatory: "CTAO"
@@ -37,7 +39,7 @@ data:
     collection: "telescopes"
     observatory: "CTAO"
     site: ["North", "South"]
-    design_types: ["design", "test", "FlashCam", "NectarCam"]
+    design_types: ["FlashCam", "NectarCam", "test"]
     description: "Mid-sized telescope"
   ILLN:
     collection: "calibration_devices"