gammasimtools 0.18.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

simtools/applications/generate_default_metadata.py

@@ -21,16 +21,13 @@ r"""
 
     """
 
-import json
 import logging
 from pathlib import Path
 
-import yaml
-
 import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.data_model import metadata_model
-from simtools.io_operations import io_handler
+from simtools.io import ascii_handler, io_handler
 
 
 def _parse(label, description):
@@ -74,8 +71,8 @@ def main():  # noqa: D103
         label, description="Generate a default simtools metadata file from a json schema."
     )
 
-    _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"]))
 
     default_values = metadata_model.get_default_metadata_dict(args_dict["schema"])
 
@@ -83,24 +80,11 @@ def main():  # noqa: D103
         print(default_values)
     else:
         _io_handler = io_handler.IOHandler()
-        _out_file = _io_handler.get_output_file(args_dict["output_file"])
-        _logger.info(f"Writing default values to {_out_file}")
-        if args_dict["output_file"].endswith((".yml", ".yaml")):
-            with open(_out_file, "w", encoding="utf-8") as file:
-                yaml.dump(
-                    default_values,
-                    file,
-                    default_flow_style=False,
-                    sort_keys=False,
-                )
-        if args_dict["output_file"].endswith(".json"):
-            with open(_out_file, "w", encoding="utf-8") as file:
-                json.dump(
-                    default_values,
-                    file,
-                    indent=4,
-                    sort_keys=False,
-                )
+        output_file = _io_handler.get_output_file(args_dict["output_file"])
+        logger.info(f"Writing default values to {output_file}")
+        ascii_handler.write_data_to_file(
+            data=default_values, output_file=output_file, sort_keys=False
+        )
 
 
 if __name__ == "__main__":

simtools/applications/generate_simtel_event_data.py

@@ -24,19 +24,19 @@ The output consists of an HDF5 or FITS file containing the following tables:
 +-------------------+---------+-----------------------------------------------+
 | energy_max        | float32 | Maximum simulated energy (TeV)                |
 +-------------------+---------+-----------------------------------------------+
-| viewcone_min      | float32 | Min viewcone angle (rad)                      |
+| viewcone_min      | float32 | Min viewcone angle (deg)                      |
 +-------------------+---------+-----------------------------------------------+
-| viewcone_max      | float32 | Max viewcone angle (rad)                      |
+| viewcone_max      | float32 | Max viewcone angle (deg)                      |
 +-------------------+---------+-----------------------------------------------+
 | core_scatter_min  | float32 | Min core scatter radius (m)                   |
 +-------------------+---------+-----------------------------------------------+
 | core_scatter_max  | float32 | Max core scatter radius (m)                   |
 +-------------------+---------+-----------------------------------------------+
-| zenith            | float32 | Zenith angle (rad)                            |
+| zenith            | float32 | Zenith angle (deg)                            |
 +-------------------+---------+-----------------------------------------------+
-| azimuth           | float32 | Azimuth angle (rad)                           |
+| azimuth           | float32 | Azimuth angle (deg)                           |
 +-------------------+---------+-----------------------------------------------+
-| nsb_level         | float64 | Night sky background level (photons/deg^2/ns) |
+| nsb_level         | float64 | Night sky background level (factor to dark)   |
 +-------------------+---------+-----------------------------------------------+
 
 **SHOWERS**
@@ -56,9 +56,9 @@ The output consists of an HDF5 or FITS file containing the following tables:
 +------------------+---------+-----------------------------------------------+
 | y_core           | float64 | Shower core Y position on ground (m)          |
 +------------------+---------+-----------------------------------------------+
-| shower_azimuth   | float64 | Direction of shower azimuth (rad)             |
+| shower_azimuth   | float64 | Direction of shower azimuth (deg)             |
 +------------------+---------+-----------------------------------------------+
-| shower_altitude  | float64 | Direction of shower altitude (rad)            |
+| shower_altitude  | float64 | Direction of shower altitude (deg)            |
 +------------------+---------+-----------------------------------------------+
 | area_weight      | float64 | Weighting factor for sampling area            |
 +------------------+---------+-----------------------------------------------+
@@ -74,9 +74,9 @@ The output consists of an HDF5 or FITS file containing the following tables:
 +-----------------+---------+-----------------------------------------------+
 | file_id         | int64   | Internal unique identifier for the file       |
 +-----------------+---------+-----------------------------------------------+
-| array_altitude  | float64 | Altitude of array pointing direction (rad)    |
+| array_altitude  | float64 | Altitude of array pointing direction (deg)    |
 +-----------------+---------+-----------------------------------------------+
-| array_azimuth   | float64 | Azimuth of array pointing direction (rad)     |
+| array_azimuth   | float64 | Azimuth of array pointing direction (deg)     |
 +-----------------+---------+-----------------------------------------------+
 | telescope_list  | string  | Comma-separated list of triggered telescopes  |
 +-----------------+---------+-----------------------------------------------+
@@ -130,7 +130,7 @@ from pathlib import Path
 import simtools.utils.general as gen
 from simtools.configuration import configurator
 from simtools.data_model.metadata_collector import MetadataCollector
-from simtools.io_operations import io_handler, io_table_handler
+from simtools.io import io_handler, table_handler
 from simtools.simtel.simtel_io_event_writer import SimtelIOEventDataWriter
 
 
@@ -187,7 +187,7 @@ def main():  # noqa: D103
     output_filepath = io_handler.IOHandler().get_output_file(args_dict["output_file"])
     generator = SimtelIOEventDataWriter(files, args_dict["max_files"])
     tables = generator.process_files()
-    io_table_handler.write_tables(tables, output_filepath, overwrite_existing=True)
+    table_handler.write_tables(tables, output_filepath, overwrite_existing=True)
     MetadataCollector.dump(args_dict=args_dict, output_file=output_filepath.with_suffix(".yml"))
 
     if args_dict["print_dataset_information"] > 0:

simtools/applications/maintain_simulation_model_add_production_table.py

@@ -0,0 +1,71 @@
+r"""
+Generate new simulation model production tables by copying existing table and apply modifications.
+
+This script should be used to maintain the simulation model repository. It allow to create a
+new production table by copying an existing base version and apply modification defined in a YAML
+file (see the example file listed below).
+
+Example
+-------
+.. code-block:: console
+
+    simtools-maintain-simulation-model-add-production-table \\
+        --simulation_models_path ../simulation-models-dev/simulation-models/ \\
+        --source_prod_table_dir 6.0.0 \\
+        --modifications tests/resources/production_tables_changes_for_threshold_study_6.2.0.yml
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.model import model_repository
+
+
+def _parse(label, description):
+    """
+    Parse command line arguments.
+
+    Returns
+    -------
+    dict
+        Parsed command-line arguments.
+    """
+    config = configurator.Configurator(label=label, description=description)
+    config.parser.add_argument(
+        "--simulation_models_path",
+        type=str,
+        required=True,
+        help="Path to the simulation models repository.",
+    )
+    config.parser.add_argument(
+        "--source_prod_table_dir",
+        type=str,
+        required=True,
+        help="The source production table directory to copy from.",
+    )
+    config.parser.add_argument(
+        "--modifications",
+        type=str,
+        required=True,
+        help="File containing the list of changes to apply.",
+    )
+
+    return config.initialize(db_config=False, output=False)
+
+
+def main():  # noqa: D103
+    label = Path(__file__).stem
+    args_dict, _ = _parse(
+        label=label, description=("Copy and update simulation model production tables.")
+    )
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    model_repository.copy_and_update_production_table(args_dict)
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/maintain_simulation_model_compare_productions.py

@@ -0,0 +1,98 @@
+r"""
+Compare two directories with model production tables in JSON format.
+
+This script should be used to support the maintenance the simulation model repository.
+
+Example
+-------
+.. code-block:: console
+
+    simtools-maintain-simulation-model-compare-productions \\
+        --directory_1 ../simulation-models-dev/simulation-models/6.0.0/ \\
+        --directory_2 ../simulation-models-dev/simulation-models/6.2.0
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.io import ascii_handler
+
+
+def _parse(label, description):
+    """Parse command line arguments."""
+    config = configurator.Configurator(label=label, description=description)
+    config.parser.add_argument(
+        "--directory_1",
+        type=str,
+        required=True,
+        help="Path to the first directory containing JSON files.",
+    )
+    config.parser.add_argument(
+        "--directory_2",
+        type=str,
+        required=True,
+        help="Path to the second directory containing JSON files.",
+    )
+    return config.initialize(db_config=False, output=False)
+
+
+def _print_differences(differences, rel_path):
+    """Print differences in a readable format."""
+    print(f"Difference in {rel_path}:\n{'-' * 40}")
+    for diff in differences:
+        # Clean up the path formatting for better readability
+        clean_diff = diff.replace("['parameters']['", "parameters.").replace("']['", ".")
+        clean_diff = clean_diff.replace("['", "").replace("']", "")
+        print(f"  {clean_diff}")
+    print(f"{'-' * 40}\n")
+
+
+def _compare_json_dirs(dir1, dir2, ignore_key="model_version"):
+    """Compare two directories containing JSON files, ignoring a specific key."""
+    for path1 in dir1.rglob("*.json"):
+        rel_path = path1.relative_to(dir1)
+        path2 = dir2 / rel_path
+
+        if not path2.exists():
+            print(f"Missing in dir2: {rel_path}")
+            continue
+
+        try:
+            json1 = gen.remove_key_from_dict(
+                ascii_handler.collect_data_from_file(path1), ignore_key
+            )
+            json2 = gen.remove_key_from_dict(
+                ascii_handler.collect_data_from_file(path2), ignore_key
+            )
+        except FileNotFoundError as e:
+            print(f"Error reading {rel_path}: {e}")
+            continue
+
+        differences = gen.find_differences_in_json_objects(json1, json2)
+        if differences:
+            _print_differences(differences, rel_path)
+
+    # Check for files present in dir2 but not dir1
+    for path2 in dir2.rglob("*.json"):
+        rel_path = path2.relative_to(dir2)
+        if not (dir1 / rel_path).exists():
+            print(f"Missing in dir1: {rel_path}")
+
+
+def main():  # noqa: D103
+    label = Path(__file__).stem
+    args_dict, _ = _parse(
+        label=label,
+        description=("Compare two directories with model production tables in JSON format."),
+    )
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    _compare_json_dirs(Path(args_dict["directory_1"]), Path(args_dict["directory_2"]))
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/{verify_simulation_model_production_tables.py → maintain_simulation_model_verify_production_tables.py}

@@ -1,12 +1,20 @@
 #!/usr/bin/python3
 
-"""
+r"""
 Verify simulation model production tables and model parameters for completeness.
 
 This application is a utility to be used in the CI pipeline of the SimulationModels
 repository. It checks that all model parameters defined in the production tables
 exist in the simulation models repository.
 
+Example
+-------
+
+.. code-block:: console
+
+    simtools-maintain-simulation-model-verify-production-tables \\
+        --simulation_models_path /path/to/simulation/models/repository
+
 """
 
 import logging

simtools/applications/merge_tables.py

@@ -41,7 +41,7 @@ from pathlib import Path
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.io_operations import io_handler, io_table_handler
+from simtools.io import io_handler, table_handler
 
 
 def _parse(label, description):
@@ -91,7 +91,7 @@ def main():  # noqa: D103
     output_path = io_handler.IOHandler().get_output_directory(label)
     output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
 
-    io_table_handler.merge_tables(
+    table_handler.merge_tables(
         input_files,
         input_table_names=args_dict["table_names"],
         output_file=output_filepath,

simtools/applications/plot_array_layout.py

@@ -13,7 +13,7 @@ For the following options, array element positions are retrieved from the model
   (``--plot_all_layouts``)
 
 * from a model parameter file
-  (e.g., ``-array_layout_parameter_file tests/resources/model_parameters/array_layouts-2.0.1.json``)
+  (e.g., ``-array_layout_parameter_file tests/resources/model_parameters/array_layouts-2.0.2.json``)
 
 * from a list of array elements (e.g., ``-array_element_list MSTN-01, MSTN-02``).
   Positions are retrieved from the database.
@@ -88,7 +88,7 @@ Plot layout from a parameter file with a list of telescopes:
 .. code-block:: console
 
     simtools-plot-array-layout
-        --array_layout_parameter_file tests/resources/model_parameters/array_layouts-2.0.1.json
+        --array_layout_parameter_file tests/resources/model_parameters/array_layouts-2.0.2.json
         --model_version 6.0.0
 
 
@@ -108,7 +108,7 @@ import matplotlib.pyplot as plt
 import simtools.layout.array_layout_utils as layout_utils
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.io_operations import io_handler
+from simtools.io import io_handler
 from simtools.visualization import visualize
 from simtools.visualization.plot_array_layout import plot_array_layout