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

simtools/applications/make_regular_arrays.py

@@ -1,160 +0,0 @@
-#!/usr/bin/python3
-
-"""
-    Summary
-    -------
-
-    This application creates the layout array files (ECSV) of regular arrays
-    with one telescope at the center of the array and with 4 telescopes
-    in a square grid. These arrays are used for trigger rate simulations.
-
-    The array layout files created should be available at the data/layout directory.
-
-    Command line arguments
-    ----------------------
-    site (str, required)
-        observatory site (e.g., North or South).
-    model_version (str, optional)
-        Model version to use (e.g., prod6). If not provided, the latest version is used.
-    verbosity (str, optional)
-        Log level to print.
-
-    Example
-    -------
-    Runtime < 10 s.
-
-    .. code-block:: console
-
-        simtools-make-regular-arrays --site=North
-
-"""
-
-import logging
-import os
-from pathlib import Path
-
-import astropy.units as u
-
-import simtools.data_model.model_data_writer as writer
-import simtools.utils.general as gen
-from simtools import db_handler
-from simtools.configuration import configurator
-from simtools.io_operations import io_handler
-from simtools.layout.array_layout import ArrayLayout
-
-
-def main():
-    config = configurator.Configurator(
-        label=Path(__file__).stem,
-        description=(
-            "This application creates the layout array files (ECSV) of regular arrays "
-            "with one telescope at the center of the array and with 4 telescopes "
-            "in a square grid. These arrays are used for trigger rate simulations. "
-            "The array layout files created should be available at the data/layout directory."
-        ),
-    )
-    args_dict, db_config = config.initialize(db_config=True, site_model=True, output=True)
-
-    label = "make_regular_arrays"
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    _io_handler = io_handler.IOHandler()
-
-    corsika_pars = gen.collect_data_from_file_or_dict(
-        _io_handler.get_input_data_file("parameters", "corsika_parameters.yml"), None
-    )
-
-    # Reading site parameters from DB
-    db = db_handler.DatabaseHandler(mongo_db_config=db_config)
-    site_pars_db = db.get_site_parameters(
-        site=args_dict["site"], model_version=args_dict["model_version"]
-    )
-
-    layout_center_data = {}
-    layout_center_data["center_lat"] = float(site_pars_db["ref_lat"]["Value"]) * u.deg
-    layout_center_data["center_lon"] = float(site_pars_db["ref_long"]["Value"]) * u.deg
-    layout_center_data["center_alt"] = float(site_pars_db["altitude"]["Value"]) * u.m
-    layout_center_data["EPSG"] = site_pars_db["EPSG"]["Value"]
-    corsika_telescope_data = {}
-    corsika_telescope_data["corsika_obs_level"] = layout_center_data["center_alt"]
-    corsika_telescope_data["corsika_sphere_center"] = corsika_pars["corsika_sphere_center"]
-    corsika_telescope_data["corsika_sphere_radius"] = corsika_pars["corsika_sphere_radius"]
-
-    # Telescope distances for 4 tel square arrays
-    # !HARDCODED
-    telescope_distance = {"LST": 57.5 * u.m, "MST": 70 * u.m, "SST": 80 * u.m}
-
-    for array_name in ["1SST", "4SST", "1MST", "4MST", "1LST", "4LST"]:
-        logger.info(f"Processing array {array_name}")
-        layout = ArrayLayout(
-            site=args_dict["site"],
-            mongo_db_config=db_config,
-            label=label,
-            name=f"{args_dict['site']}-{array_name}",
-            layout_center_data=layout_center_data,
-            corsika_telescope_data=corsika_telescope_data,
-        )
-
-        tel_size = array_name[1:4]
-
-        # Single telescope at the center
-        if array_name[0] == "1":
-            layout.add_telescope(
-                telescope_name=tel_size + "-01",
-                crs_name="ground",
-                xx=0 * u.m,
-                yy=0 * u.m,
-                tel_corsika_z=0 * u.m,
-            )
-        # 4 telescopes in a regular square grid
-        else:
-            layout.add_telescope(
-                telescope_name=tel_size + "-01",
-                crs_name="ground",
-                xx=telescope_distance[tel_size],
-                yy=telescope_distance[tel_size],
-                tel_corsika_z=0 * u.m,
-            )
-            layout.add_telescope(
-                telescope_name=tel_size + "-02",
-                crs_name="ground",
-                xx=-telescope_distance[tel_size],
-                yy=telescope_distance[tel_size],
-                tel_corsika_z=0 * u.m,
-            )
-            layout.add_telescope(
-                telescope_name=tel_size + "-03",
-                crs_name="ground",
-                xx=telescope_distance[tel_size],
-                yy=-telescope_distance[tel_size],
-                tel_corsika_z=0 * u.m,
-            )
-            layout.add_telescope(
-                telescope_name=tel_size + "-04",
-                crs_name="ground",
-                xx=-telescope_distance[tel_size],
-                yy=-telescope_distance[tel_size],
-                tel_corsika_z=0 * u.m,
-            )
-
-        layout.convert_coordinates()
-        layout.print_telescope_list()
-        output_file = args_dict.get("output_file", None)
-        if output_file is not None:
-            base_name, file_extension = os.path.splitext(output_file)
-            output_file = f"{base_name}-{args_dict['site']}-{array_name}{file_extension}"
-        writer.ModelDataWriter.dump(
-            args_dict=args_dict,
-            output_file=output_file,
-            metadata=None,
-            product_data=layout.export_telescope_list_table(
-                crs_name="ground",
-                corsika_z=False,
-            ),
-        )
-
-
-if __name__ == "__main__":
-    main()

simtools/applications/produce_array_config.py

@@ -1,136 +0,0 @@
-#!/usr/bin/python3
-
-"""
-    Summary
-    -------
-    This application is an example of how to produce sim_telarray config \
-    files for a given array.
-
-    All the input required has to be given as a yaml file by the command \
-    line argument array_config.
-
-    The required entries in the array_config file are:
-
-    'site': South or North
-
-    'layout_name': name of a valid layout array.
-
-    'model_version': name of a valid model version.
-
-    'default': telescope model names to be assigned to each telescope size by default. \
-    It must contain entries for 'LST' and 'MST' (and 'SST' in case of South site).
-
-    As optional data, specific telescope models can be assigned to individual telescopes. \
-    This is done by the entries with the name of the telescope (as used by the layout \
-    definition, ex. LST-01, MST-05, SST-10).
-
-    Each telescope model can be set in two ways.
-
-    a) A single str with the name of telescope model.
-    Ex. 'MST-05': 'NectarCam-D'
-
-    b) A dict containing a 'name' key with the name of the telescope model and further keys \
-    with model parameters to be changed from the original model.
-    Ex.:
-
-    .. code-block:: python
-
-        'MST-05': {
-                'name': 'NectarCam-D',
-                'fadc_pulse_shape': 'Pulse_template_nectarCam_17042020-noshift.dat',
-                'discriminator_pulse_shape': 'Pulse_template_nectarCam_17042020-noshift.dat'
-            }
-
-    This is an example of the content of an array_config file.
-
-    .. code-block:: python
-
-        site: North,
-        layout_name: Prod5
-        model_version: Prod5
-        default:
-            LST: 'D234'  # Design model for the LSTs
-            MST: FlashCam-D  # Design model for the MST-FlashCam
-        LST-01: '1'  # Model of LST-01 in the LaPalma site.
-        MST-05:
-            name: NectarCam-D
-            # Parameters to be changed
-            fadc_pulse_shape: Pulse_template_nectarCam_17042020-noshift.dat
-            discriminator_pulse_shape: Pulse_template_nectarCam_17042020-noshift.dat
-
-    Command line arguments
-    ----------------------
-    label (str, optional)
-        Label to identify the output files/directories.
-    array_config (str, required)
-        Path to a yaml file with the array config data.
-    verbosity (str, optional)
-        Log level to print.
-
-    Example
-    -------
-    North - Prod5, simple example
-
-    Get the array configuration from DB:
-
-    .. code-block:: console
-
-        simtools-get-file-from-db --file_name array_config_test.yml
-
-    Run the application. Runtime < 1 min.
-
-    .. code-block:: console
-
-        simtools-produce-array-config --label test --array_config \
-        array_config_test.yml
-
-    The output is saved in simtools-output/test/model.
-
-    Expected final print-out message:
-
-    .. code-block:: console
-
-        INFO::array_model(l361)::export_simtel_array_config_file::Writing array config file into \
-        /workdir/external/simtools/simtools-output/test/model/CTA-TestLayout-North-2020-06-\
-        28_test.cfg
-"""
-
-import logging
-from pathlib import Path
-
-import simtools.utils.general as gen
-from simtools.configuration import configurator
-from simtools.model.array_model import ArrayModel
-
-
-def main():
-    config = configurator.Configurator(
-        label=Path(__file__).stem,
-        description=("Example of how to produce sim_telarray config files for a given array."),
-    )
-    config.parser.add_argument(
-        "--array_config",
-        help="Yaml file with array config data.",
-        type=str,
-        required=True,
-    )
-    args_dict, db_config = config.initialize(db_config=True)
-
-    logger = logging.getLogger("simtools")
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    array_model = ArrayModel(
-        label=args_dict["label"],
-        mongo_db_config=db_config,
-        array_config_file=args_dict["array_config"],
-    )
-
-    # Printing list of telescope for quick inspection.
-    array_model.print_telescope_list()
-
-    # Exporting config files.
-    array_model.export_all_simtel_config_files()
-
-
-if __name__ == "__main__":
-    main()

simtools/applications/production.py

@@ -1,313 +0,0 @@
-#!/usr/bin/python3
-
-"""
-    Summary
-    -------
-    This application perform array simulations.
-
-    The simulations are split into two stages: showers and array.
-    Shower simulations are performed with CORSIKA and array simulations \
-    with sim_telarray. Note that either shower or array simulations are \
-    submitted (so typically you first run shower simulations, and then the \
-    array simulations).
-
-    By default the configuration is saved in simtools-output/test-production
-    and the output in corsika-data and simtel-data. The location of the latter directories
-    can be set to a different location via the option --data_directory.
-
-    A configuration file is required.
-
-    The workload management system used is given in the configuration file. \
-    Allowed systems are qsub (using gridengine), condor_submit \
-    (using HTcondor), and local (running the script locally).
-
-    Command line arguments
-    ----------------------
-    productionconfig (str, required)
-        Path to the simulation configuration file.
-    primary (str)
-        Name of the primary to be selected from the configuration file. In case it \
-        is not given, all the primaries listed in the configuration file will be simulated.
-        The choices are: gamma, electron, proton, helium, nitrogen, silicon, and iron.
-    task (str)
-        What task to execute. Options:
-            simulate (perform simulations),
-            file_list (print list of output files)
-            inspect (plot sim_telarray histograms for quick inspection)
-            resources (print quicklook into used computational resources)
-    array_only (activation mode)
-        Simulates only array detector (no showers).
-    showers_only (activation mode)
-        Simulates only showers (no array detector).
-    test (activation mode, optional)
-        If activated, no job will be submitted, but all configuration files \
-        and run scripts will be created.
-    data_directory (str, optional)
-        The location of the output directories corsika-data and simtel-data.
-    corsika_files (str, optional)
-        The CORSIKA files to pass to simtel_array.
-        If it is provided, these CORSIKA files are used and the application does not search for them
-        in the data directory.
-        This option should only be used in combination with the `showers_only` option.
-    verbosity (str, optional)
-        Log level to print.
-
-    Example
-    -------
-    Testing a mini-prod5 simulation.
-
-    Get the configuration file from the DB
-
-    .. code-block:: console
-
-        simtools-get-file-from-db --file_name prod_config_test.yml
-
-    Run the application:
-
-    .. code-block:: console
-
-        simtools-production --task simulate --productionconfig prod_config_test.yml \
-        --test --showers_only --submit_command local
-
-    The output is saved in simtools-output/test-production.
-
-    Expected final print-out message:
-
-    .. code-block:: console
-
-        INFO::job_manager(l124)::_submit_local::Running script locally
-        INFO::job_manager(l133)::_submit_local::Testing (local)
-"""
-
-import logging
-from copy import copy
-from pathlib import Path
-
-from astropy.io.misc import yaml
-
-import simtools.utils.general as gen
-from simtools.configuration import configurator
-from simtools.simulator import Simulator
-
-
-def _parse(description=None):
-    """
-    Parse command line configuration
-
-    Parameters
-    ----------
-    description: str
-        description of application.
-
-    Returns
-    -------
-    CommandLineParser
-        command line parser object
-
-    """
-
-    config = configurator.Configurator(description=description)
-    config.parser.add_argument(
-        "--productionconfig",
-        help="Simulation configuration file",
-        type=str,
-        required=True,
-    )
-    config.parser.add_argument(
-        "--task",
-        help=(
-            "What task to execute. Options: "
-            "simulate (perform simulations),"
-            "file_list (print list of output files),"
-            "inspect (plot sim_telarray histograms for quick inspection),"
-            "resources (print report of computing resources)"
-        ),
-        type=str,
-        required=True,
-        choices=["simulate", "file_list", "inspect", "resources"],
-    )
-    config.parser.add_argument(
-        "--primary",
-        help="Primary to be selected from the simulation configuration file.",
-        type=str,
-        required=False,
-        choices=[
-            "gamma",
-            "electron",
-            "proton",
-            "helium",
-            "nitrogen",
-            "silicon",
-            "iron",
-        ],
-    )
-    config.parser.add_argument(
-        "--data_directory",
-        help="The directory where to save the corsika-data and simtel-data output directories.",
-        type=str.lower,
-        required=False,
-        default="./",
-    )
-    config.parser.add_argument(
-        "--corsika_files",
-        help="The CORSIKA files to pass to simtel_array.",
-        type=str,
-        required=False,
-        default=None,
-    )
-    group = config.parser.add_mutually_exclusive_group(required=True)
-    group.add_argument(
-        "--showers_only",
-        help="Simulates only showers, no array detection",
-        action="store_true",
-    )
-    group.add_argument(
-        "--array_only",
-        help="Simulates only array detection, no showers",
-        action="store_true",
-    )
-    return config.initialize(db_config=True, job_submission=True)
-
-
-def _proccess_simulation_config_file(config_file, primary_config, logger):
-    """
-    Read simulation configuration file with details on shower
-    and array simulations
-
-    Attributes
-    ----------
-    config_file: str
-        Name of simulation configuration file
-    primary_config: str
-        Name of the primary selected from the configuration file.
-
-    Returns
-    -------
-    str
-        label of simulation configuration
-    dict
-        configuration of shower simulations
-    dict
-        configuration of array simulations
-
-    """
-
-    try:
-        with open(config_file, encoding="utf-8") as file:
-            config_data = yaml.load(file)
-    except FileNotFoundError:
-        logger.error(f"Error loading simulation configuration file from {config_file}")
-        raise
-
-    label = config_data.pop("label", {})
-    default_data = config_data.pop("default", {})
-    config_showers = {}
-    config_arrays = {}
-
-    for primary, primary_data in config_data.items():
-        if primary_config is not None and primary != primary_config:
-            continue
-
-        this_default = copy(default_data)
-
-        config_showers[primary] = copy(this_default.pop("showers", {}))
-        config_arrays[primary] = copy(this_default.pop("array", {}))
-
-        # Grabbing common entries for showers and array
-        for key, value in primary_data.items():
-            if key in ["showers", "array"]:
-                continue
-            config_showers[primary][key] = value
-            config_arrays[primary][key] = value
-
-        # Grabbing showers entries
-        for key, value in primary_data.get("showers", {}).items():
-            config_showers[primary][key] = value
-        config_showers[primary]["primary"] = primary
-
-        # Grabbing array entries
-        for key, value in primary_data.get("array", {}).items():
-            config_arrays[primary][key] = value
-        config_arrays[primary]["primary"] = primary
-
-        # Filling in the remaining default keys
-        for key, value in this_default.items():
-            config_showers[primary][key] = value
-            config_arrays[primary][key] = value
-    return label, config_showers, config_arrays
-
-
-def main():
-    args_dict, db_config = _parse(description="Air shower and array simulations")
-
-    logger = logging.getLogger()
-    logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
-
-    label, shower_configs, array_configs = _proccess_simulation_config_file(
-        args_dict["productionconfig"], args_dict["primary"], logger
-    )
-    if args_dict["label"] is None:
-        args_dict["label"] = label
-
-    if args_dict["corsika_files"] is not None and args_dict["array_only"] is False:
-        msg = "`--corsika_files` option should be used only with `--array_only` argument."
-        logger.error(msg)
-        raise ValueError
-
-    shower_simulators = {}
-    for primary, config_data in shower_configs.items():
-        if "data_directory" in args_dict:
-            config_data["data_directory"] = args_dict["data_directory"]
-        shower_simulators[primary] = Simulator(
-            label=label,
-            simulator="corsika",
-            simulator_source_path=args_dict["simtel_path"],
-            config_data=config_data,
-            submit_command=args_dict["submit_command"],
-            test=args_dict["test"],
-            mongo_db_config=db_config,
-        )
-
-    if args_dict["showers_only"]:
-        for primary, shower in shower_simulators.items():
-            _task_function = getattr(shower, args_dict["task"])
-            _task_function()
-
-    if args_dict["array_only"]:
-        array_simulators = {}
-        for primary, config_data in array_configs.items():
-            if "data_directory" in args_dict:
-                config_data["data_directory"] = args_dict["data_directory"]
-            array_simulators[primary] = Simulator(
-                label=label,
-                simulator="simtel",
-                simulator_source_path=args_dict["simtel_path"],
-                config_data=config_data,
-                submit_command=args_dict["submit_command"],
-                mongo_db_config=db_config,
-            )
-        for primary, array in array_simulators.items():
-            if args_dict["corsika_files"] is None:
-                input_list = shower_simulators[primary].get_list_of_output_files()
-            else:
-                if not isinstance(args_dict["corsika_files"], list):
-                    args_dict["corsika_files"] = [args_dict["corsika_files"]]
-                input_list = args_dict["corsika_files"]
-
-            for corsika_file in input_list:
-                if not Path(corsika_file).exists():
-                    msg = (
-                        f"CORSIKA file {corsika_file} does not exist. Please run the "
-                        "production with the `--showers_only` option first or point the "
-                        "tool to the correct path to the corsika files with "
-                        "`--corsika_directory`."
-                    )
-                    logger.error(msg)
-                    raise FileNotFoundError
-            logger.info(f"Getting CORSIKA files: {input_list}.")
-            _task_function = getattr(array, args_dict["task"])
-            _task_function(input_file_list=input_list)
-
-
-if __name__ == "__main__":
-    main()