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

[GernotMaier]

simtools.utils.names is one of the simtools base classes, but grew over the past months and was therefore a bit more difficult to understand.

This PR tries to improve docstrings and naming plus applies some minor refactoring to names.py. Also added a more extended module docstring to explain a bit better the differences between the different named items.

In detail:

• load_model_parameters() --> _load_model_parameters() now private; improve efficiency by reading all files only once
• name change: all_model_parameters() --> model_parameters()
• name change: get_array_element_name_from_type_site_id()-->generate_array_element_name_from_type_site_id`
• removed guess_design_model_from_name() not used anywhere (and wrong response for MSTS/MSTN)
• removed get_parameter_name_from_simtel_name() not used anywhere
• removed layout_telescope_list_file_name() not used anywhere
• added a function called is_design_type(array_element_name) to check if a given array element is a design element (e.g. is LSTN-design)

Improved and corrected also reading of design models for a given array element type (this triggered the improvement of the documentation; I didn't understand some functions in names.py).

Closes #1391.

[ctao-dpps-sonarqube]

Analysis Details

0 Issues

• 0 Bugs
• 0 Vulnerabilities
• 0 Code Smells

Coverage and Duplications

• 95.80% Coverage (94.20% Estimated after merge)
• 0.00% Duplicated Code (0.00% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube