gammasimtools 0.21.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

{gammasimtools-0.21.0.dist-info → gammasimtools-0.22.0.dist-info}/entry_points.txt

@@ -11,6 +11,7 @@ simtools-db-get-array-layouts-from-db = simtools.applications.db_get_array_layou
 simtools-db-get-file-from-db = simtools.applications.db_get_file_from_db:main
 simtools-db-get-parameter-from-db = simtools.applications.db_get_parameter_from_db:main
 simtools-db-inspect-databases = simtools.applications.db_inspect_databases:main
+simtools-db-upload-model-repository = simtools.applications.db_upload_model_repository:main
 simtools-derive-ctao-array-layouts = simtools.applications.derive_ctao_array_layouts:main
 simtools-derive-mirror-rnda = simtools.applications.derive_mirror_rnda:main
 simtools-derive-photon-electron-spectrum = simtools.applications.derive_photon_electron_spectrum:main
@@ -39,9 +40,9 @@ simtools-production-derive-statistics = simtools.applications.production_derive_
 simtools-production-generate-grid = simtools.applications.production_generate_grid:main
 simtools-production-merge-corsika-limits = simtools.applications.production_merge_corsika_limits:main
 simtools-run-application = simtools.applications.run_application:main
-simtools-simulate-calibration-events = simtools.applications.simulate_calibration_events:main
 simtools-simulate-flasher = simtools.applications.simulate_flasher:main
 simtools-simulate-illuminator = simtools.applications.simulate_illuminator:main
+simtools-simulate-pedestals = simtools.applications.simulate_pedestals:main
 simtools-simulate-prod = simtools.applications.simulate_prod:main
 simtools-simulate-prod-htcondor-generator = simtools.applications.simulate_prod_htcondor_generator:main
 simtools-submit-array-layouts = simtools.applications.submit_array_layouts:main

simtools/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.21.0'
-__version_tuple__ = version_tuple = (0, 21, 0)
+__version__ = version = '0.22.0'
+__version_tuple__ = version_tuple = (0, 22, 0)
 
 __commit_id__ = commit_id = None

simtools/applications/calculate_incident_angles.py

@@ -144,10 +144,7 @@ def main():
 
     logger.info("Starting calculation of incident angles")
 
-    output_base = Path(args_dict.get("output_path", "./"))
-    output_dir = (
-        output_base / label if not args_dict.get("use_plain_output_path", False) else output_base
-    )
+    output_dir = Path(args_dict.get("output_path", "./"))
     base_label = args_dict.get("label", label)
     telescope_name = args_dict["telescope"]
     label_with_telescope = f"{base_label}_{telescope_name}"

simtools/applications/convert_all_model_parameters_from_simtel.py

@@ -233,8 +233,7 @@ def read_and_export_parameters(args_dict, logger):
             parameter_version=args_dict["parameter_version"],
             output_file=io_handler.get_output_file(
                 f"{_parameter}-{args_dict['parameter_version']}.json",
-                label=f"{args_dict['telescope']}",
-                sub_dir=f"{_parameter}",
+                sub_dir=[f"{args_dict['telescope']}", f"{_parameter}"],
             ),
         )
 

simtools/applications/convert_model_parameter_from_simtel.py

@@ -109,7 +109,6 @@ def main():  # noqa: D103
         parameter_version=args_dict["parameter_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}")
 

simtools/applications/db_generate_compound_indexes.py

@@ -40,25 +40,12 @@ def main():  # noqa: D103
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
     db = db_handler.DatabaseHandler(mongo_db_config=db_config)
-    # databases without internal databases we don't have rights to modify
-    databases = [
-        d for d in db.db_client.list_database_names() if d not in ("config", "admin", "local")
-    ]
-    requested = db.get_db_name(
+
+    db.generate_compound_indexes_for_databases(
         db_name=args_dict["db_name"],
+        db_simulation_model=args_dict.get("db_simulation_model"),
         db_simulation_model_version=args_dict.get("db_simulation_model_version"),
-        model_name=args_dict.get("db_simulation_model"),
     )
-    if requested != "all" and requested not in databases:
-        raise ValueError(
-            f"Requested database '{requested}' not found. "
-            f"Following databases are available: {', '.join(databases)}"
-        )
-
-    databases = databases if requested == "all" else [requested]
-    for db_name in databases:
-        logger.info(f"Generating compound indexes for database: {db_name}")
-        db.generate_compound_indexes(db_name=db_name)
 
 
 if __name__ == "__main__":

simtools/applications/db_upload_model_repository.py

@@ -0,0 +1,122 @@
+#!/usr/bin/python3
+r"""
+Upload model parameters from simulation model repository to a local or remote database.
+
+This script clones the CTAO simulation model repository and uploads model parameters
+and production tables to a MongoDB database. It includes retry functionality for
+network operations and confirmation prompts for remote database uploads.
+
+Command line arguments
+----------------------
+db_simulation_model (str, required)
+    Name of the database simulation model.
+db_simulation_model_version (str, required)
+    Version of the database simulation model.
+branch (str, optional)
+    Repository branch to clone (if not provided, uses the version tag).
+tmp_dir (str, optional)
+    Temporary directory for cloning the repository (default: ./tmp_model_parameters).
+
+Examples
+--------
+Upload model repository to database using a version tag
+(see simulation model repository for available tags):
+
+.. code-block:: console
+
+    simtools-db-upload-model-repository \\
+        --db_simulation_model CTAO-Simulation-Model \\
+        --db_simulation_model_version v10.10.10
+
+Upload model repository using specific branch (the version tag is
+used to name the database, but no tag checkout is done):
+
+.. code-block:: console
+
+    simtools-db-upload-model-repository \\
+        --db_simulation_model CTAO-Simulation-Model \\
+        --db_simulation_model_version v10.10.10 \\
+        --branch main
+
+"""
+
+import logging
+from pathlib import Path
+
+import simtools.utils.general as gen
+from simtools.configuration import configurator
+from simtools.db import db_handler, db_model_upload
+
+DEFAULT_REPOSITORY_URL = (
+    "https://gitlab.cta-observatory.org/cta-science/simulations/"
+    "simulation-model/simulation-models.git"
+)
+
+
+def _parse(label=None, description=None):
+    """
+    Parse command line configuration.
+
+    Parameters
+    ----------
+    label : str
+        Label describing application.
+    description : str
+        Description of application.
+
+    Returns
+    -------
+    tuple
+        Command line parser object and database configuration.
+    """
+    config = configurator.Configurator(label=label, description=description)
+    config.parser.add_argument(
+        "--branch",
+        help="Repository branch to clone (optional, defaults to using version tag).",
+        type=str,
+        required=False,
+    )
+    config.parser.add_argument(
+        "--tmp_dir",
+        help="Temporary directory for cloning the repository (default: ./tmp_model_parameters).",
+        type=str,
+        default="tmp_model_parameters",
+        required=False,
+    )
+
+    args_dict, db_config = config.initialize(output=True, require_command_line=True, db_config=True)
+
+    if args_dict.get("db_simulation_model_version"):
+        db_config["db_simulation_model"] = args_dict.get(
+            "db_simulation_model", "CTAO-Simulation-Model"
+        )
+        db_config["db_simulation_model_version"] = args_dict["db_simulation_model_version"]
+    else:
+        raise ValueError("Setting of db_simulation_model_version is required.")
+
+    return args_dict, db_config
+
+
+def main():
+    """Application main."""
+    args_dict, db_config = _parse(
+        label=Path(__file__).stem, description="Upload model parameters from repository to database"
+    )
+    logger = logging.getLogger()
+    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
+
+    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
+    db.print_connection_info()
+
+    db_model_upload.add_complete_model(
+        tmp_dir=args_dict.get("tmp_dir"),
+        db=db,
+        db_simulation_model=args_dict.get("db_simulation_model"),
+        db_simulation_model_version=args_dict.get("db_simulation_model_version"),
+        repository_url=DEFAULT_REPOSITORY_URL,
+        repository_branch=args_dict.get("branch"),
+    )
+
+
+if __name__ == "__main__":
+    main()

simtools/applications/derive_psf_parameters.py

@@ -184,6 +184,12 @@ def _parse():
         help="Use KS statistic for monte carlo uncertainty analysis.",
         action="store_true",
     )
+    config.parser.add_argument(
+        "--fraction",
+        help="PSF containment fraction for diameter calculation (e.g., 0.8 for D80, 0.95 for D95).",
+        type=float,
+        default=0.8,
+    )
     return config.initialize(
         db_config=True,
         simulation_model=["telescope", "model_version", "parameter_version"],
@@ -198,8 +204,7 @@ def main():  # noqa: D103
     logger.setLevel(get_log_level_from_user(args_dict["log_level"]))
 
     _io_handler = io_handler.IOHandler()
-    output_dir = _io_handler.get_output_directory(label, sub_dir="application-plots")
-    tel_model, site_model = initialize_simulation_models(
+    tel_model, site_model, _ = initialize_simulation_models(
         label=label,
         db_config=db_config,
         site=args_dict["site"],
@@ -207,7 +212,12 @@ def main():  # noqa: D103
         model_version=args_dict["model_version"],
     )
 
-    psf_opt.run_psf_optimization_workflow(tel_model, site_model, args_dict, output_dir)
+    psf_opt.run_psf_optimization_workflow(
+        tel_model,
+        site_model,
+        args_dict,
+        _io_handler.get_output_directory(),
+    )
 
 
 if __name__ == "__main__":

simtools/applications/docs_produce_array_element_report.py

@@ -56,7 +56,7 @@ def main():  # noqa: D103
     args, db_config = _parse(label_name)
 
     io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="productions")
+    output_path = io_handler_instance.get_output_directory()
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args["log_level"]))

simtools/applications/docs_produce_calibration_reports.py

@@ -28,7 +28,7 @@ def main():  # noqa: D103
     args, db_config = _parse(label_name)
 
     io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="productions")
+    output_path = io_handler_instance.get_output_directory()
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args["log_level"]))

simtools/applications/docs_produce_model_parameter_reports.py

@@ -41,7 +41,7 @@ def main():  # noqa: D103
     label_name = "reports"
     args, db_config = _parse(label_name)
     io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="parameters")
+    output_path = io_handler_instance.get_output_directory()
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args["log_level"]))

simtools/applications/docs_produce_simulation_configuration_report.py

@@ -29,7 +29,7 @@ def main():  # noqa: D103
     args, db_config = _parse(label_name)
 
     io_handler_instance = io_handler.IOHandler()
-    output_path = io_handler_instance.get_output_directory(label=label_name, sub_dir="productions")
+    output_path = io_handler_instance.get_output_directory()
 
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args["log_level"]))

simtools/applications/generate_corsika_histograms.py

@@ -286,7 +286,7 @@ def main():  # noqa: D103
     io_handler_instance = io_handler.IOHandler()
     args_dict, _ = _parse(label, description)
 
-    output_path = io_handler_instance.get_output_directory(label, sub_dir="application-plots")
+    output_path = io_handler_instance.get_output_directory()
 
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
     initial_time = time.time()

simtools/applications/maintain_simulation_model_add_production.py

@@ -7,11 +7,11 @@ to production tables and model parameters as provided in a YAML file (see the ex
 
 Two main use cases are covered by this script:
 
-1. full_update: Create a complete new set of production tables (e.g. for new major or minor
+1. full update: Create a complete new set of production tables (e.g. for new major or minor
    versions of the simulation models). This will copy all production tables from the source
    directory and apply the modifications to the tables that are listed in the modifications file.
 
-2. patch_update: Create a set of new production tables including the changes defined in the
+2. patch update: Create a set of new production tables including the changes defined in the
    modifications file. No unmodified tables are copied. For new production tables with patch
    modifications, the key-value pair 'base_model_version: <base_model version>' is added.
 
@@ -27,9 +27,7 @@ The following example applies a patch update with changes defined in a YAML file
 
     simtools-maintain-simulation-model-add-new-production \\
         --simulation_models_path ../simulation-models-dev/simulation-models/ \\
-        --base_model_version 6.0.0 \\
-        --modifications tests/resources/production_tables_changes_for_threshold_study_6.2.0.yml \\
-        --patch_update
+        --modifications tests/resources/production_tables_changes_for_threshold_study_6.2.0.yml
 
 """
 
@@ -57,37 +55,12 @@ def _parse(label, description):
         required=True,
         help="Path to the simulation models repository.",
     )
-    config.parser.add_argument(
-        "--base_model_version",
-        type=str,
-        required=True,
-        help="Base model version (which is the source production table subdirectory to copy from).",
-    )
     config.parser.add_argument(
         "--modifications",
         type=str,
         required=True,
         help="File containing the list of changes to apply.",
     )
-    update_group = config.parser.add_mutually_exclusive_group(required=True)
-    update_group.add_argument(
-        "--full_update",
-        action="store_true",
-        default=False,
-        help=(
-            "Create a full new set of production tables by copying all tables from the "
-            "base version and applying the modifications to the relevant tables."
-        ),
-    )
-    update_group.add_argument(
-        "--patch_update",
-        action="store_true",
-        default=False,
-        help=(
-            "Create a new set of production tables including only the changes defined in the "
-            "modifications file. No unmodified tables are copied."
-        ),
-    )
 
     return config.initialize(db_config=False, output=False)
 
@@ -98,7 +71,10 @@ def main():  # noqa: D103
     logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
-    model_repository.generate_new_production(args_dict)
+    model_repository.generate_new_production(
+        modifications=args_dict["modifications"],
+        simulation_models_path=Path(args_dict["simulation_models_path"]),
+    )
 
 
 if __name__ == "__main__":

simtools/applications/merge_tables.py

@@ -88,7 +88,7 @@ def main():  # noqa: D103
         args_dict["input_files"], [".hdf5", ".gz"]
     )
 
-    output_path = io_handler.IOHandler().get_output_directory(label)
+    output_path = io_handler.IOHandler().get_output_directory()
     output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
 
     table_handler.merge_tables(

simtools/applications/plot_array_layout.py

@@ -299,8 +299,7 @@ def main():
 
         visualize.save_figure(
             fig_out,
-            io_handler_instance.get_output_directory(label, sub_dir="application-plots")
-            / plot_file_name,
+            io_handler_instance.get_output_directory() / plot_file_name,
             dpi=400,
         )
         plt.close()

simtools/applications/print_version.py

@@ -72,7 +72,7 @@ def main():
         ascii_handler.write_data_to_file(
             data=version_dict,
             output_file=io_handler_instance.get_output_file(
-                args_dict.get("output_file", "simtools_version.json"), label=label
+                args_dict.get("output_file", "simtools_version.json")
             ),
         )
 

simtools/applications/production_derive_statistics.py

@@ -149,9 +149,8 @@ def main():
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
     _io_handler = io_handler.IOHandler()
-    output_path = _io_handler.get_output_directory(label, sub_dir="")
 
-    manager = ProductionStatisticsHandler(args_dict, output_path=output_path)
+    manager = ProductionStatisticsHandler(args_dict, output_path=_io_handler.get_output_directory())
     manager.run()
 
 

simtools/applications/production_generate_grid.py

@@ -157,7 +157,7 @@ def main():
     _logger = logging.getLogger()
     _logger.setLevel(logging.INFO)
 
-    output_path = io_handler.IOHandler().get_output_directory(label)
+    output_path = io_handler.IOHandler().get_output_directory()
     output_filepath = Path(output_path).joinpath(f"{args_dict['output_file']}")
 
     axes = load_axes(args_dict["axes"])

simtools/applications/simulate_flasher.py

@@ -1,48 +1,59 @@
 #!/usr/bin/python3
 
 r"""
-Simulate flasher devices using the light emission package.
+Simulate flasher devices used e.g. for camera flat fielding.
 
-Run the application in the command line.
+The flasher simulation allows for two different run modes:
+
+1. Direct injection of light into the camera (bypassing the telescope optics).
+2. Simulation of the full light path (using the light-emission package from sim_telarray).
+
+The direct injection mode uses a simplified model for the flasher light source. Both run modes
+provide events in sim_telarray format that can be processed by standard analysis steps or
+visualized using e.g. the 'simtools-plot-simtel-events' application.
 
 Example Usage
 -------------
 
-1. Simulate flashers for a telescope:
+1. Simulate flashers for a telescope (direct injection):
+
+    .. code-block:: console
+
+        simtools-simulate-flasher --run_mode direct_injection \
+        --light_source MSFx-FlashCam --model_version 6.0.0 \
+        --array_layout_name subsystem_msts --site South \
+        --run_number 3
+
+2. Simulate flashers for a telescope (detailed simulation):
 
     .. code-block:: console
 
-        simtools-simulate-flasher --telescope MSTN-04 --site North \
-        --flasher FLSN-01 --model_version 6.0.0
+        simtools-simulate-flasher --run_mode full_simulation \
+        --light_source MSFx-FlashCam --model_version 6.0.0 \
+        --telescope MSTS-04 --site South
 
 Command Line Arguments
 ----------------------
+run_mode (str, required)
+    Run mode, either "direct_injection" or "full_simulation".
 telescope (str, required)
     Telescope model name (e.g. LSTN-01, MSTN-04, SSTS-04, ...)
 site (str, required)
     Site name (North or South).
-flasher (str, required)
-    Flasher device in array, e.g., FLSN-01.
+light_source (str, required)
+    Calibration light source, e.g., MSFx-FlashCam
 number_of_events (int, optional):
     Number of events to simulate (default: 1).
 output_prefix (str, optional):
     Prefix for output files (default: empty).
 model_version (str, optional)
     Version of the simulation model.
-
-Example
--------
-
-Simulate flashers for MSTN-04:
-
-.. code-block:: console
-
-    simtools-simulate-flasher --telescope MSTN-04 --site North \
-    --flasher FLSN-01 --model_version 6.0.0
-
-Expected Output:
-    The simulation will run the light emission package for the flasher
-    devices and produce the output files.
+array_layout_name (str, optional)
+    Name of the array layout to use (required for direct injection mode).
+run_number (int, optional)
+    Run number to use (default: 1, required for direct injection mode).
+telescope (str, optional)
+    Telescope name (required for full simulation mode).
 """
 
 import logging
@@ -50,91 +61,82 @@ from pathlib import Path
 
 import simtools.utils.general as gen
 from simtools.configuration import configurator
-from simtools.model.flasher_model import FlasherModel
-from simtools.model.model_utils import initialize_simulation_models
 from simtools.simtel.simulator_light_emission import SimulatorLightEmission
+from simtools.simulator import Simulator
 
 
 def _parse(label):
     """Parse command line configuration."""
-    config = configurator.Configurator(
-        label=label,
-        description=("Simulate flasher devices using the light emission package."),
+    config = configurator.Configurator(label=label, description="Simulate flasher devices.")
+    config.parser.add_argument(
+        "--run_mode",
+        help="Flasher simulation run mode",
+        type=str,
+        choices=["direct_injection", "full_simulation"],
+        required=True,
+        default="direct_injection",
     )
     config.parser.add_argument(
-        "--flasher",
-        help="Flasher device in array associated with a specific telescope, i.e. FLSN-01",
+        "--light_source",
+        help="Flasher device associated with a specific telescope, i.e. MSFx-FlashCam",
         type=str,
         required=True,
     )
     config.parser.add_argument(
-        "--number_events",
-        help="Number of number_events to simulate (default: 1)",
+        "--number_of_events",
+        help="Number of flasher events to simulate",
         type=int,
         default=1,
         required=False,
     )
     config.parser.add_argument(
         "--output_prefix",
-        help="Prefix for output files (default: empty)",
+        help="Prefix for output files",
         type=str,
         default=None,
         required=False,
     )
-
     return config.initialize(
         db_config=True,
-        simulation_model=["telescope", "model_version"],
-        require_command_line=True,
+        simulation_model=["site", "layout", "telescope", "model_version"],
+        simulation_configuration={
+            "corsika_configuration": ["run_number"],
+            "sim_telarray_configuration": ["all"],
+        },
     )
 
 
-def flasher_configs():
-    """Return default setup for flasher runs (no distances)."""
-    return {"light_source_setup": "layout"}
-
-
 def main():
-    """Run the application."""
+    """Simulate flasher devices."""
     label = Path(__file__).stem
-    logger = logging.getLogger(__name__)
 
     args_dict, db_config = _parse(label)
+    logger = logging.getLogger()
     logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
 
-    telescope_model, site_model = initialize_simulation_models(
-        label=label,
-        db_config=db_config,
-        site=args_dict["site"],
-        telescope_name=args_dict["telescope"],
-        model_version=args_dict["model_version"],
+    logger.info(
+        f"Flasher simulation for telescope {args_dict['telescope']} "
+        f" with light source {args_dict['light_source']} "
+        f" ({args_dict['number_of_events']} events, run mode: {args_dict['run_mode']})"
     )
 
-    flasher_model = FlasherModel(
-        site=args_dict["site"],
-        flasher_device_model_name=args_dict["flasher"],
-        mongo_db_config=db_config,
-        model_version=args_dict["model_version"],
-        label=label,
-    )
-
-    flasher_cfg = flasher_configs()
-
-    sim_runner = SimulatorLightEmission(
-        telescope_model=telescope_model,
-        flasher_model=flasher_model,
-        site_model=site_model,
-        light_emission_config=args_dict,
-        light_source_setup=flasher_cfg["light_source_setup"],
-        simtel_path=args_dict["simtel_path"],
-        light_source_type="flasher",
-        label=args_dict["label"],
-        test=args_dict.get("test", False),
-    )
-
-    sim_runner.run_simulation()
-
-    logger.info("Flasher simulation completed. Use simtools-plot-simtel-number_events for plots.")
+    if args_dict["run_mode"] == "full_simulation":
+        light_source = SimulatorLightEmission(
+            light_emission_config=args_dict,
+            db_config=db_config,
+            label=args_dict.get("label"),
+        )
+    elif args_dict["run_mode"] == "direct_injection":
+        light_source = Simulator(
+            args_dict=args_dict,
+            db_config=db_config,
+            label=args_dict.get("label"),
+        )
+    else:
+        raise ValueError(f"Unsupported run_mode: {args_dict['run_mode']}")
+
+    light_source.simulate()
+    logger.info("Flasher simulation completed.")
 
 
 if __name__ == "__main__":