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

simtools/applications/{print_array_elements.py → convert_geo_coordinates_of_array_elements.py}

@@ -1,68 +1,54 @@
 #!/usr/bin/python3
-"""
-    Summary
-    -------
-    Convert and print a list of array element positions in different coordinate \
-    systems relevant for CTAO.
+"""Convert and print a list of array element positions in different coordinate systems.
 
     Description
     -----------
 
-    This application converts a list of array element positions in different CTAO \
-    coordinate systems.
-
+    Convert array element positions in different CTAO coordinate systems.
     Available coordinate systems are:
 
     1. UTM system
-    2. ground system (similar to sim_telarray system with x-axis pointing toward \
-        geographic north and y-axis pointing towards the west)
+    2. ground system (similar to sim_telarray system with x-axis pointing toward geographic north
+       and y-axis pointing towards the west); altitude relative to the CORSIKA observation level.
+       Altitude is the height of the elevation rotation axis (plus some possible mirror offset).
     3. Mercator system
 
     Command line arguments
     ----------------------
     input (str)
-        File name with list of array element positions
-    compact (str)
-        Compact output in requested coordinate system; possible are corsika,utm,mercator
+        File name with list of array element positions.
+        Input can be given as astropy table file (ecsv) or a single array element in
+        a json file.
+    print (str)
+        Print in requested coordinate system; possible are ground, utm, mercator
     export (str)
-        Export array element list to file in requested coordinate system; \
-            possible are ground, utm, mercator
-    use_corsika_telescope_height (bool)
-        Use CORSIKA coordinates for telescope heights (requires CORSIKA observation level)
+        Export array element list to file in requested coordinate system;
+          possible are ground, utm, mercator
     select_assets (str)
         Select a subset of array elements / telescopes (e.g., MSTN, LSTN)
 
-
     Example
     -------
-    Print a list of array elements using a list of telescope positions in UTM coordinates.
+    Convert a list of array elements using a list of telescope positions in UTM coordinates.
 
     .. code-block:: console
 
-        simtools-print-array-elements \\
-            --input tests/resources/telescope_positions-South-4MST.ecsv \\
-            --compact ground
-
-    Expected final print-out message:
+        simtools-convert-geo-coordinates-of-array-elements
+            --input tests/resources/telescope_positions-North-utm.ecsv
+            --print ground
 
-    .. code-block:: console
-
-        telescope_name pos_x pos_y altitude
-        MST-01      -0.02      -0.00    2162.00
-        MST-02       1.43     151.02    2163.00
-        MST-03      -1.47    -151.02    2169.00
-        MST-04     150.72      73.57    2159.00
+    The converted list of telescope positions in ground coordinates is printed to the screen.
 
-    The following example converts a list of telescope positions in UTM coordinates \
-    and writes the output to a file in ground (sim_telarray) coordinates. Also selects \
+    The following example converts a list of telescope positions in UTM coordinates
+    and writes the output to a file in ground (sim_telarray) coordinates. Also selects
     only a subset of the array elements (telescopes; ignore calibration devices):
 
     .. code-block:: console
 
-        simtools-print-array-elements \\
-            --input tests/resources/telescope_positions-North-utm.ecsv \\
-            --export ground --use_corsika_telescope_height \\
-            --select_assets LSTN, MSTN, SSTN
+        simtools-convert-geo-coordinates-of-array-elements
+            --input tests/resources/telescope_positions-North-utm.ecsv
+            --export ground
+            --select_assets LSTN
 
     Expected output is a ecsv file in the directory printed to the screen.
 
@@ -80,7 +66,7 @@ from simtools.layout import array_layout
 
 def _parse(label=None, description=None):
     """
-    Parse command line configuration
+    Parse command line configuration.
 
     Parameters
     ----------
@@ -93,15 +79,13 @@ def _parse(label=None, description=None):
     -------
     CommandLineParser
         Command line parser object
-
     """
-
     config = configurator.Configurator(label=label, description=description)
 
     config.parser.add_argument(
         "--input",
         help="list of array element positions",
-        required=False,
+        required=True,
     )
     config.parser.add_argument(
         "--input_meta",
@@ -110,8 +94,8 @@ def _parse(label=None, description=None):
         required=False,
     )
     config.parser.add_argument(
-        "--compact",
-        help="compact output (in requested coordinate system)",
+        "--print",
+        help="print list of positions in requested coordinate system",
         required=False,
         default="",
         choices=[
@@ -131,13 +115,6 @@ def _parse(label=None, description=None):
             "mercator",
         ],
     )
-    config.parser.add_argument(
-        "--use_corsika_telescope_height",
-        help="Use CORSIKA coordinates for telescope heights (requires CORSIKA observation level)",
-        required=False,
-        default=False,
-        action="store_true",
-    )
     config.parser.add_argument(
         "--select_assets",
         help="select a subset of assets (e.g., MSTN, LSTN)",
@@ -152,21 +129,39 @@ def _parse(label=None, description=None):
         required=False,
         action="store_true",
     )
-    return config.initialize(output=True, require_command_line=True)
+    return config.initialize(
+        output=True, require_command_line=True, db_config=True, simulation_model=["version", "site"]
+    )
 
 
 def main():
+    """Print a list of array elements."""
     label = Path(__file__).stem
     data_model_name = "array_coordinates"
-    args_dict, _ = _parse(
+    args_dict, db_config = _parse(
         label,
         description=f"Print a list of array element positions ({data_model_name})",
     )
 
-    _logger = logging.getLogger()
-    _logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    json_type = args_dict.get("input", "").endswith(".json")
+    # simplified metadata treatment for model parameter json files
+    if json_type:
+        site = args_dict.get("site", None)
+        top_level_meta = None
+        validate_schema_file = None
+    else:
+        metadata = MetadataCollector(args_dict=args_dict, data_model_name=data_model_name)
+        site = metadata.get_site(from_input_meta=True)
+        top_level_meta = metadata.top_level_meta
+        validate_schema_file = metadata.get_data_model_schema_file_name()
 
     layout = array_layout.ArrayLayout(
+        mongo_db_config=db_config,
+        model_version=args_dict["model_version"],
+        site=site,
         telescope_list_file=args_dict["input"],
         telescope_list_metadata_file=args_dict["input_meta"],
         validate=not args_dict["skip_input_validation"],
@@ -175,20 +170,20 @@ def main():
     layout.convert_coordinates()
 
     if args_dict["export"] is not None:
-        _metadata = MetadataCollector(args_dict=args_dict, data_model_name=data_model_name)
+        product_data = (
+            layout.export_one_telescope_as_json(crs_name=args_dict["export"])
+            if json_type
+            else layout.export_telescope_list_table(crs_name=args_dict["export"])
+        )
         writer.ModelDataWriter.dump(
             args_dict=args_dict,
-            metadata=_metadata.top_level_meta,
-            product_data=layout.export_telescope_list_table(
-                crs_name=args_dict["export"],
-                corsika_z=args_dict["use_corsika_telescope_height"],
-            ),
-            validate_schema_file=_metadata.get_data_model_schema_file_name(),
+            metadata=top_level_meta,
+            product_data=product_data,
+            validate_schema_file=validate_schema_file,
         )
     else:
         layout.print_telescope_list(
-            compact_printing=args_dict["compact"],
-            corsika_z=args_dict["use_corsika_telescope_height"],
+            crs_name=args_dict["print"],
         )
 
 

simtools/applications/convert_model_parameter_from_simtel.py

@@ -0,0 +1,119 @@
+#!/usr/bin/python3
+r"""
+    Convert simulation model parameter from sim_telarray format using the corresponding schema file.
+
+    Check value, type, and range and write a json file ready to be submitted to the model database.
+
+    Command line arguments
+    ----------------------
+    parameter (str, required)
+        Parameter name (as used in simtools)
+
+    simtel_cfg_file (str)
+        File name of sim_telarray configuration file containing all simulation model parameters.
+
+    simtel_telescope_name (str)
+        Name of the telescope in the sim_telarray configuration file.
+
+    telescope (str, optional)
+        Telescope model name (e.g. LST-1, SST-D, ...)
+
+    Example
+    -------
+
+    Extract the num_gains parameter from a sim_telarray configuration file for LSTN-01
+    and write a json file in the same format as the model parameter database:
+
+    .. code-block:: console
+
+       simtools-convert-model-parameter-from-simtel \\
+          --simtel_telescope_name CT1 \\
+          --telescope LSTN-01 \\
+          --schema tests/resources/num_gains.schema.yml \\
+          --simtel_cfg_file tests/resources/simtel_config_test_la_palma.cfg \\
+          --output_file num_gains.json
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.data_model.model_data_writer as writer
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.simtel.simtel_config_reader import SimtelConfigReader
+
+
+def _parse(label=None, description=None):
+    """
+    Parse command line configuration.
+
+    Parameters
+    ----------
+    label: str
+        Label describing application.
+    description: str
+        Description of application.
+
+    Returns
+    -------
+    CommandLineParser
+        Command line parser object
+
+    """
+    config = configurator.Configurator(label=label, description=description)
+
+    config.parser.add_argument(
+        "--schema", help="Schema file for model parameter validation", required=True
+    )
+    config.parser.add_argument(
+        "--simtel_cfg_file",
+        help="File name for simtel_array configuration",
+        type=str,
+        required=True,
+    )
+    config.parser.add_argument(
+        "--simtel_telescope_name",
+        help="Name of the telescope in the sim_telarray configuration file",
+        type=str,
+        required=True,
+    )
+    return config.initialize(simulation_model="telescope", output=True)
+
+
+def main():  # noqa: D103
+
+    args_dict, _ = _parse(
+        label=Path(__file__).stem,
+        description="Convert simulation model parameter from sim_telarray to simtools format.",
+    )
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    simtel_config_reader = SimtelConfigReader(
+        schema_file=args_dict["schema"],
+        simtel_config_file=args_dict["simtel_cfg_file"],
+        simtel_telescope_name=args_dict["simtel_telescope_name"],
+    )
+    logger.info(f"Simtel parameter: {simtel_config_reader.parameter_dict}")
+    if simtel_config_reader.parameter_dict is None or len(simtel_config_reader.parameter_dict) == 0:
+        logger.error("Parameter not found in sim_telarray configuration file.")
+        return
+
+    simtel_config_reader.compare_simtel_config_with_schema()
+
+    _json_dict = writer.ModelDataWriter.dump_model_parameter(
+        parameter_name=simtel_config_reader.parameter_name,
+        value=simtel_config_reader.parameter_dict.get(args_dict["simtel_telescope_name"]),
+        instrument=args_dict["telescope"],
+        model_version=args_dict["model_version"],
+        output_file=args_dict["output_file"],
+        output_path=args_dict.get("output_path"),
+        use_plain_output_path=args_dict.get("use_plain_output_path"),
+    )
+    logger.info(f"Validated parameter: {_json_dict}")
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/{add_file_to_db.py → db_add_file_to_db.py}

@@ -1,9 +1,7 @@
 #!/usr/bin/python3
 
 """
-    Summary
-    -------
-    This application adds a file to a DB.
+    Add a file to a DB.
 
     The name and location of the file are required.
     This application should complement the ones for updating parameters, \
@@ -14,7 +12,7 @@
     file_name (str or list of str, required)
         Name of the file to upload including the full path. \
         A list of files is also allowed, in which case only one -file_name is necessary, \
-        i.e., python applications/add_file_to_db.py -file_name file_1.dat file_2.dat file_3.dat \
+        i.e., python applications/db_add_file_to_db.py -file_name file_1.dat file_2.dat file_3.dat \
         If no path is given, the file is assumed to be in the CWD.
     input_path (str, required if file_name is not given)
         A directory with files to upload to the DB. \
@@ -22,8 +20,6 @@
     db (str)
         The DB to insert the files to. \
         The choices are either the default CTA simulation DB or a sandbox for testing.
-    verbosity (str, optional)
-        Log level to print.
 
     Example
     -------
@@ -31,7 +27,7 @@
 
     .. code-block:: console
 
-        simtools-add-file-to-db --file_name test_application.dat --db test-data
+        simtools-db-add-file-to-db --file_name test_application.dat --db test-data
 
     Expected final print-out message:
 
@@ -46,78 +42,64 @@ import logging
 from pathlib import Path
 
 import simtools.utils.general as gen
-from simtools import db_handler
 from simtools.configuration import configurator
+from simtools.db import db_handler
 
 
-def _user_confirm():
-    """
-    Ask the user to enter y or n (case-insensitive).
-
-    Returns
-    -------
-    bool: True if the answer is Y/y.
-    """
-
-    answer = ""
-    while answer not in ["y", "n"]:
-        try:
-            answer = input("Is this OK? [y/n]").lower()
-            return answer == "y"
-        except EOFError:
-            return False
-    return False
-
-
-def main():
-    _db_tmp = db_handler.DatabaseHandler(mongo_db_config=None)
+def _parse():
 
     config = configurator.Configurator(
         description="Add file to the DB.",
         usage="simtools-add-file-to-db --file_name test_application.dat --db test-data",
     )
+
     group = config.parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         "--file_name",
-        help=(
-            "The file name to upload. "
-            "A list of files is also allowed, in which case only one -f is necessary, "
-            "i.e., python applications/add_file_to_db.py --file_name file_1.dat file_2.dat "
-            "file_3.dat. If no path is given, the file is assumed to be in the CWD."
-        ),
+        help=("The file name to upload. A list of files is also allowed."),
         type=str,
         nargs="+",
     )
     group.add_argument(
         "--input_path",
-        help=(
-            "A directory with files to upload to the DB. "
-            "All files in the directory with the following extensions "
-            f"will be uploaded: {', '.join(_db_tmp.ALLOWED_FILE_EXTENSIONS)}"
-        ),
+        help=("A directory with files to upload to the DB."),
         type=Path,
     )
+
     config.parser.add_argument(
         "--db",
         type=str,
-        default=_db_tmp.DB_TABULATED_DATA,
-        choices=[
-            _db_tmp.DB_TABULATED_DATA,
-            _db_tmp.DB_DERIVED_VALUES,
-            _db_tmp.DB_REFERENCE_DATA,
-            "sandbox",
-            "test-data",
-        ],
         help=("The database to insert the files to."),
     )
-    args_dict, db_config = config.initialize(paths=False, db_config=True)
 
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+    return config.initialize(paths=False, db_config=True)
 
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
 
+def collect_files_to_insert(args_dict, logger, db):
+    """
+    Collect the files to insert into the database based on the provided arguments.
+
+    Parameters
+    ----------
+    args_dict : dict
+        Dictionary of parsed command-line arguments.
+    logger : logging.Logger
+        Logger object for logging messages.
+    db : DatabaseHandler
+        Database handler object.
+
+    Returns
+    -------
+    list
+        List of files to be inserted into the database.
+
+    Raises
+    ------
+    ValueError
+        If no valid files are provided for uploading.
+    """
     files_to_insert = []
+
     if args_dict.get("file_name", None) is not None:
         for file_now in args_dict["file_name"]:
             if Path(file_now).suffix in db.ALLOWED_FILE_EXTENSIONS:
@@ -131,23 +113,51 @@ def main():
         for ext_now in db.ALLOWED_FILE_EXTENSIONS:
             files_to_insert.extend(Path(args_dict["input_path"]).glob(f"*{ext_now}"))
 
-    plural = "s"
-    if len(files_to_insert) < 1:
+    if not files_to_insert:
         raise ValueError("No files were provided to upload")
-    if len(files_to_insert) == 1:
-        plural = ""
-    else:
-        pass
+
+    return files_to_insert
+
+
+def confirm_and_insert_files(files_to_insert, args_dict, db, logger):
+    """
+    Confirm the files to be inserted and insert them into the database.
+
+    Parameters
+    ----------
+    files_to_insert : list
+        List of files to be inserted into the database.
+    args_dict : dict
+        Dictionary of parsed command-line arguments.
+    db : DatabaseHandler
+        Database handler object.
+    logger : logging.Logger
+        Logger object for logging messages.
+    """
+    plural = "" if len(files_to_insert) == 1 else "s"
 
     print(f"Should the following file{plural} be inserted to the {args_dict['db']} DB?:\n")
     print(*files_to_insert, sep="\n")
     print()
-    if _user_confirm():
+
+    if gen.user_confirm():
         for file_to_insert_now in files_to_insert:
             db.insert_file_to_db(file_to_insert_now, args_dict["db"])
             logger.info(f"File {file_to_insert_now} inserted to {args_dict['db']} DB")
     else:
-        logger.info(f"Aborted, did not insert file {plural} to the {args_dict['db']} DB")
+        logger.info(f"Aborted, did not insert file{plural} to the {args_dict['db']} DB")
+
+
+def main():  # noqa: D103
+    args_dict, db_config = _parse()
+
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+
+    files_to_insert = collect_files_to_insert(args_dict, logger, db)
+    confirm_and_insert_files(files_to_insert, args_dict, db, logger)
 
 
 if __name__ == "__main__":