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

simtools/configuration/configurator.py

@@ -1,3 +1,5 @@
+"""Application configuration."""
+
 import argparse
 import logging
 import os
@@ -13,11 +15,11 @@ from simtools.utils import general as gen
 
 __all__ = [
     "Configurator",
-    "InvalidConfigurationParameter",
+    "InvalidConfigurationParameterError",
 ]
 
 
-class InvalidConfigurationParameter(Exception):
+class InvalidConfigurationParameterError(Exception):
     """Exception for Invalid configuration parameter."""
 
 
@@ -51,10 +53,7 @@ class Configurator:
     """
 
     def __init__(self, config=None, label=None, usage=None, description=None, epilog=None):
-        """
-        Initialize Configurator.
-        """
-
+        """Initialize Configurator."""
         self._logger = logging.getLogger(__name__)
         self._logger.debug("Init Configuration")
 
@@ -71,7 +70,7 @@ class Configurator:
 
     def default_config(self, arg_list=None, add_db_config=False):
         """
-        Returns dictionary of default configuration
+        Return dictionary of default configuration.
 
         Parameters
         ----------
@@ -85,10 +84,13 @@ class Configurator:
         dict
             Configuration parameters as dict.
         """
-
         self.parser.initialize_default_arguments()
+        simulation_model = None
         if arg_list and "--site" in arg_list:
-            self.parser.initialize_telescope_model_arguments(True, "--telescope" in arg_list)
+            simulation_model = ["site"]
+        if arg_list and "--telescope" in arg_list:
+            simulation_model = ["site", "telescope"]
+        self.parser.initialize_simulation_model_arguments(simulation_model)
         if add_db_config:
             self.parser.initialize_db_config_arguments()
 
@@ -100,14 +102,15 @@ class Configurator:
         require_command_line=True,
         paths=True,
         output=False,
-        telescope_model=False,
-        site_model=False,
+        simulation_model=None,
+        simulation_configuration=None,
         db_config=False,
         job_submission=False,
     ):
         """
-        Initialize configuration from command line, configuration file, class config, or \
-        environmental variable.
+        Initialize application configuration.
+
+        Configure from command line, configuration file, class config, or environmental variable.
 
         Priorities in parameter settings.
         1. command line; 2. yaml file; 3. class init; 4. env variables.
@@ -124,10 +127,10 @@ class Configurator:
             Add path configuration to list of args.
         output: bool
             Add output file configuration to list of args.
-        telescope_model: bool
-            Add telescope model configuration to list of args.
-        site_model: bool
-            Add site model configuration to list of args (not required if telescope_model is set)
+        simulation_model: list
+            List of simulation model configuration parameters to add to list of args
+        simulation_configuration: dict
+            Dict of simulation software configuration parameters to add to list of args.
         db_config: bool
             Add database configuration parameters to list of args.
         job_submission: bool
@@ -140,18 +143,12 @@ class Configurator:
         dict
             Dictionary with DB parameters
 
-        Raises
-        ------
-        InvalidConfigurationParameter
-           if parameter has already been defined with a different value.
-
         """
-
         self.parser.initialize_default_arguments(
             paths=paths,
             output=output,
-            telescope_model=telescope_model,
-            site_model=site_model,
+            simulation_model=simulation_model,
+            simulation_configuration=simulation_configuration,
             db_config=db_config,
             job_submission=job_submission,
         )
@@ -176,6 +173,7 @@ class Configurator:
     def _fill_from_command_line(self, arg_list=None, require_command_line=True):
         """
         Fill configuration parameters from command line arguments.
+
         Triggers a print of the help if no command line arguments are given and
         require_command_line is set.
 
@@ -186,13 +184,7 @@ class Configurator:
         require_command_line: bool
             Require at least one command line argument.
 
-        Raises
-        ------
-        InvalidConfigurationParameter
-              invalid configuration.
-
         """
-
         if arg_list is None:
             arg_list = sys.argv[1:]
 
@@ -208,12 +200,11 @@ class Configurator:
     def _reset_required_arguments(self):
         """
         Reset required parser arguments (i.e., arguments added with "required=True").
-        Includes also mutually exclusive groups.
 
+        Includes also mutually exclusive groups.
         Access protected attributes of parser (no public method available).
 
         """
-
         for group in self.parser._mutually_exclusive_groups:  # pylint: disable=protected-access
             group.required = False
         for action in self.parser._actions:  # pylint: disable=protected-access
@@ -221,8 +212,9 @@ class Configurator:
 
     def _fill_from_config_dict(self, input_dict, overwrite=False):
         """
-        Fill configuration parameters from dictionary. Enforce that configuration parameter names\
-         are lower case.
+        Fill configuration parameters from dictionary.
+
+        Enforce that configuration parameter names are lower case.
 
         Parameters
         ----------
@@ -245,8 +237,9 @@ class Configurator:
 
     def _check_parameter_configuration_status(self, key, value):
         """
-        Check if a parameter is already configured and not still set to the default value. Allow \
-        configuration with None values.
+        Check if a parameter is already configured and not still set to the default value.
+
+        Allow configuration with None values.
 
         Parameters
         ----------
@@ -256,10 +249,8 @@ class Configurator:
 
         Raises
         ------
-        InvalidConfigurationParameter
+        InvalidConfigurationParameterError
            if parameter has already been defined with a different value.
-
-
         """
         # parameter not changed or None
         if self.parser.get_default(key) == self.config[key] or self.config[key] is None:
@@ -271,7 +262,7 @@ class Configurator:
                 f"Inconsistent configuration parameter ({key}) definition "
                 f"({self.config[key]} vs {value})"
             )
-            raise InvalidConfigurationParameter
+            raise InvalidConfigurationParameterError
 
     def _fill_from_config_file(self, config_file):
         """
@@ -288,11 +279,10 @@ class Configurator:
            if configuration file has not been found.
 
         """
-
         try:
             self._logger.debug(f"Reading configuration from {config_file}")
-            _config_dict = gen.collect_data_from_file_or_dict(
-                file_name=config_file, in_dict=None, allow_empty=True
+            _config_dict = (
+                gen.collect_data_from_file(file_name=config_file) if config_file else None
             )
             # yaml parser adds \n in multiline strings, remove them
             _config_dict = gen.remove_substring_recursively_from_dict(_config_dict, substring="\n")
@@ -319,11 +309,11 @@ class Configurator:
 
     def _fill_from_environmental_variables(self):
         """
-        Fill any configuration parameters which is not already configured (i.e., parameter is None)
-        from environmental variables or from file (default: ".env").
+        Fill any configuration parameters from environmental variables or from file (e.g., ".env").
 
-        """
+        Only parameters which are not already configured are changed (i.e., parameter is None).
 
+        """
         _env_dict = {}
         try:
             load_dotenv(self.config["env_file"])
@@ -341,10 +331,7 @@ class Configurator:
         self._fill_from_config_dict(_env_dict)
 
     def _initialize_io_handler(self):
-        """
-        Initialize IOHandler with input and output paths.
-
-        """
+        """Initialize IOHandler with input and output paths."""
         _io_handler = io_handler.IOHandler()
         _io_handler.set_paths(
             output_path=self.config.get("output_path", None),
@@ -354,11 +341,9 @@ class Configurator:
         )
 
     def _initialize_output(self):
-        """
-        Initialize default output file names (in case output_file is not configured).
-
-        """
+        """Initialize default output file names (in case output_file is not configured)."""
         if self.config.get("output_file", None) is None:
+            self.config["output_file_from_default"] = True
             prefix = "TEST"
             label = extension = ""
             if not self.config.get("test", False):
@@ -395,17 +380,15 @@ class Configurator:
             Dict keys and values as dict.
 
         """
-
         if isinstance(input_var, dict):
             _list_args = []
             for key, value in input_var.items():
                 if isinstance(value, list):
                     _list_args.append("--" + key)
-                    _list_args += value
-                elif isinstance(value, u.Quantity):
-                    _list_args.append("--" + key)
-                    _list_args.append(str(value))
-                elif not isinstance(value, bool) and value is not None and len(str(value)) > 0:
+                    _list_args.extend(map(str, value))
+                elif isinstance(value, u.Quantity) or (
+                    not isinstance(value, bool) and value is not None and len(str(value)) > 0
+                ):
                     _list_args.append("--" + key)
                     _list_args.append(str(value))
                 elif value:
@@ -418,7 +401,7 @@ class Configurator:
             return []
 
     @staticmethod
-    def _convert_stringnone_to_none(input_dict):
+    def _convert_string_none_to_none(input_dict):
         """
         Convert string type 'None' to type None (argparse returns None as str).
 
@@ -428,7 +411,6 @@ class Configurator:
             Dictionary with values to be converted.
 
         """
-
         for key, value in input_dict.items():
             input_dict[key] = None if value == "None" else value
 
@@ -442,10 +424,8 @@ class Configurator:
         ----------
         input_container
             List or dictionary with configuration updates.
-
         """
-
-        self.config = self._convert_stringnone_to_none(
+        self.config = self._convert_string_none_to_none(
             vars(
                 self.parser.parse_args(
                     self._arglist_from_config(self.config)
@@ -456,18 +436,22 @@ class Configurator:
 
     def _get_db_parameters(self):
         """
-        Return parameters for DB configuration
+        Return parameters for DB configuration.
 
         Parameters
         ----------
         dict
             Dictionary with DB parameters
-
-
         """
-
         _db_dict = {}
-        _db_para = ("db_api_user", "db_api_pw", "db_api_port", "db_server")
+        _db_para = (
+            "db_api_user",
+            "db_api_pw",
+            "db_api_port",
+            "db_server",
+            "db_simulation_model",
+            "db_simulation_model_url",
+        )
         try:
             for _para in _db_para:
                 _db_dict[_para] = self.config[_para]

simtools/constants.py

@@ -1,9 +1,9 @@
 """Project wide constants."""
 
+from pathlib import Path
+
 # Path to metadata jsonschema
-METADATA_JSON_SCHEMA = "schemas/metadata.metaschema.yml"
-# Path to data and modelparameter jsonschema
-DATA_JSON_SCHEMA = "schemas/data.metaschema.yml"
+METADATA_JSON_SCHEMA = Path(__file__).parent / "../simtools/schemas/metadata.metaschema.yml"
 
-# URL to the schema repository
-SCHEMA_URL = "https://raw.githubusercontent.com/gammasim/workflows/main/schemas/"
+# Path to model parameter schema files
+MODEL_PARAMETER_SCHEMA_PATH = Path(__file__).parent / "../simtools/schemas/model_parameters"