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

simtools/schemas/model_parameters/camera_filter.schema.yml

@@ -0,0 +1,45 @@
+%YAML 1.2
+---
+title: Schema for camera_filter model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+developer_note: To be replaced by a data table
+name: camera_filter
+description: |-
+  Wavelength dependence of the camera filter transmission, independent
+  of the pixel type.  The transmission may be given for the average or
+  various incidence angles.  In the latter case, the transmission is
+  applied for each photon as a function of both its wavelength and its
+  incidence angle.  The efficiency factors will be applied on top of the
+  global par:camera-transmission factor, and on top of any pixel-type
+  dependent efficiency (both angular and by wavelength), according to
+  the what is listed in par:camera_config_pixel_type.
+short_description: |-
+  Wavelength dependence of the camera transmission, possibly as a function
+  of incidence angle.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_filter_incidence_angle.schema.yml

@@ -0,0 +1,29 @@
+%YAML 1.2
+---
+title: Schema for camera_filter_incidence_angle model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+developer_note: To be replaced by a data table
+name: camera_filter_incidence_angle
+description: |-
+  Distribution of incidence angle on the camera filter.
+data:
+  - type: file
+    unit: dimensionless
+    default: 'no_such_file.dat'
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - SimPipe Derived
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/camera_pixels.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for camera_pixels model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: camera_pixels
+description: Number of pixels in the camera.
+developer_note: |-
+  Max limit depend on sim_telarray pre-compiler settings
+data:
+  - type: uint
+    default: 1
+    allowed_range:
+      min: 1
+      max: 11328
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGeometry
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/camera_transmission.schema.yml

@@ -0,0 +1,41 @@
+%YAML 1.2
+---
+title: Schema for camera_transmission model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: camera_transmission
+description: |-
+  Global wavelength-independent transmission factor of the camera,
+  including any plexiglas window (note that transmission might be
+  included in the par:camera-filter file).
+short_description: |-
+  Global wavelength-independent transmission factor of the camera,
+  including any plexiglass window.
+data:
+  - type: double
+    default: 1.0
+    allowed_range:
+      min: 0.01
+      max: 1.0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTelescopeEfficiency
+    - ValidateTelescopeSimulationModel
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/channels_per_chip.schema.yml

@@ -0,0 +1,36 @@
+%YAML 1.2
+---
+title: Schema for channels_per_chip model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: channels_per_chip
+description: |-
+  Number of channels per readout chip.
+  Potentially useful for crosstalk calculations.
+short_description: Number of channels per readout chip.
+data:
+  - type: uint
+    unit: dimensionless
+    default: 4
+    allowed_range:
+      min: 0
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/correct_nsb_spectrum_to_telescope_altitude.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for correct_nsb_spectrum_to_telescope_altitude model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: correct_nsb_spectrum_to_telescope_altitude
+description: |-
+  Correct the night-sky background spectrum to the telescope altitude from the altitude where
+  the Benn & Ellison spectrum was measured.
+  The correction is done within sim_telarray
+  and is based on the atmospheric transmission to 2200 m a.s.l (atm_trans_2200_1_3_0_0_0.dat).
+data:
+  - type: file
+    unit: dimensionless
+    default: "atm_trans_2200_1_3_0_0_0.dat"
+instrument:
+  class: Telescope
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Calibration
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/corsika_cherenkov_photon_bunch_size.schema.yml

@@ -0,0 +1,27 @@
+%YAML 1.2
+---
+title: Schema for corsika_cherenkov_photon_bunch_size model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+developer_note: |-
+  Different default than sim_telarray. No use of having HEGRA defaults.
+name: corsika_cherenkov_photon_bunch_size
+description: |-
+  Cherenkov bunch size definition.
+data:
+  - type: float64
+    unit: dimensionless
+    default: 1.
+    allowed_range:
+      min: 0.
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_cherenkov_photon_wavelength_range.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for corsika_cherenkov_photon_wavelength_range model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_cherenkov_photon_wavelength_range
+description: |-
+  Cherenkov photon wavelength band.
+data:
+  - name: wavlgl
+    type: float64
+    description: Lower limit of the Cherenkov photon wavelength band.
+    unit: nm
+    default: 240.
+    allowed_range:
+      min: 100.
+      max: 1000.
+    required: true
+  - name: wavlgu
+    type: float64
+    description: Upper limit of the Cherenkov photon wavelength band.
+    unit: nm
+    default: 1000.
+    allowed_range:
+      min: 100.
+      max: 1000.
+    required: true
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_first_interaction_height.schema.yml

@@ -0,0 +1,28 @@
+%YAML 1.2
+---
+title: Schema for corsika_first_interaction_height model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_first_interaction_height
+description: |-
+  Starting altitude of primary particles in altitude above observation level.
+  This parameter should be set to values other than '0.' for specialized studies
+  only. See CORSIKA manual for details.
+data:
+  - type: float64
+    unit: cm
+    default: 0.
+    allowed_range:
+      min: 0.
+      max: 11280000.0
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_iact_io_buffer.schema.yml

@@ -0,0 +1,23 @@
+%YAML 1.2
+---
+title: Schema for corsika_iact_io_buffer model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_iact_io_buffer
+description: |-
+  Maximum size of data blocks written by the CORSIKA IACT module.
+data:
+  - type: int
+    unit: byte
+    default: 100000000
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_iact_max_bunches.schema.yml

@@ -0,0 +1,27 @@
+%YAML 1.2
+---
+title: Schema for corsika_iact_max_bunches model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_iact_max_bunches
+short_description: |-
+  Maximum number of bunches that can be kept per telescope, including in temporary files.
+description: |-
+  Maximum number of bunches that can be kept per telescope, including in temporary files.
+  Telescopes for which this limit is exceeded will have the number of bunches reduced in
+  increasing powers of two (by discarding every second bunch and adding its bunch size to the bunch kept).
+data:
+  - type: int
+    unit: dimensionless
+    default: 1000000
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_iact_split_auto.schema.yml

@@ -0,0 +1,28 @@
+%YAML 1.2
+---
+title: Schema for corsika_iact_split_auto model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_iact_split_auto
+short_description: |-
+  Maximum number of bunches before splitting into several blocks (per telescope).
+description: |-
+  Maximum number of bunches before splitting into several blocks (per telescope).
+  If the full data block for the entire array would exceed the given number of bunches,
+  it gets split up into separate blocks per individual telescope, in order to avoid
+  exceeding the hard I/O buffer size limit.
+data:
+  - type: int
+    unit: dimensionless
+    default: 15000000
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_longitudinal_shower_development.schema.yml

@@ -0,0 +1,27 @@
+%YAML 1.2
+---
+title: Schema for corsika_longitudinal_shower_development model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_longitudinal_shower_development
+description: |-
+  Step size for recording of longitudinal shower development.
+  Any value >=1. for the step size enables the recording of the shower development.
+data:
+  - type: float64
+    unit: g/cm2
+    default: 20.0
+    allowed_range:
+      min: 0.
+      max: 14998.
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_observation_level.schema.yml

@@ -0,0 +1,38 @@
+%YAML 1.2
+---
+title: Schema for corsika_observation_level model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_observation_level
+description: |-
+  Observation altitude above see level assumed in the air-shower code.
+  This should be lower than the lowest altitude of any telescope.
+short_description: Observation altitude above see level assumed in the air-shower code.
+data:
+  - type: double
+    unit: m
+    allowed_range:
+      min: 0.0
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika
+    internal_parameter_name: OBSLEV
+  - name: sim_telarray
+    internal_parameter_name: altitude

simtools/schemas/model_parameters/corsika_particle_kinetic_energy_cutoff.schema.yml

@@ -0,0 +1,52 @@
+%YAML 1.2
+---
+title: Schema for corsika_particle_kinetic_energy_cutoff model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_particle_kinetic_energy_cutoff
+description: |-
+  Kinetic energy cutoffs for different particle types.
+data:
+  - name: hadrons
+    type: float64
+    description: Kinetic energy cutoffs for hadrons.
+    unit: GeV
+    default: 0.3
+    allowed_range:
+      min: 0.05
+    required: true
+  - name: muons
+    type: float64
+    description: Kinetic energy cutoffs for muons.
+    unit: GeV
+    default: 0.1
+    allowed_range:
+      min: 0.01
+    required: true
+  - name: electrons
+    type: float64
+    description: Kinetic energy cutoffs for electrons.
+    unit: GeV
+    default: 0.020
+    allowed_range:
+      min: 0.00005
+    required: true
+  - name: gammas
+    type: float64
+    description: Kinetic energy cutoffs for gammas.
+    unit: GeV
+    default: 0.020
+    allowed_range:
+      min: 0.00005
+    required: true
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/corsika_starting_grammage.schema.yml

@@ -0,0 +1,27 @@
+%YAML 1.2
+---
+title: Schema for corsika_starting_grammage model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: corsika_starting_grammage
+description: |-
+  Starting altitude of the primary particle in mass overburden for all showers.
+  This parameter should be set to values other than '0.' for specialized studies
+  only. See CORSIKA manual for details.
+data:
+  - type: float64
+    unit: g/cm2
+    default: 0.
+    allowed_range:
+      min: 0.
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Configuration
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/dark_events.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for dark_events model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: dark_events
+description: |-
+  Pedestal events at start of run with camera lid closed (completely dark, no NSB).
+short_description: |-
+  Pedestal events at start of run closed lid.
+data:
+  - type: int
+    unit: dimensionless
+    default: 0
+    allowed_range:
+      min: 0
+instrument:
+  class: Calibration
+  type:
+    - ILLN
+    - ILLS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/default_trigger.schema.yml

@@ -0,0 +1,35 @@
+%YAML 1.2
+---
+title: Schema for default_trigger model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: default_trigger
+description: Trigger algorithm used.
+data:
+  - type: string
+    default: Majority
+    unit: dimensionless
+    allowed_values:
+      - Majority
+      - AnalogSum
+      - DigitalSum
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/design_model.schema.yml

@@ -0,0 +1,31 @@
+%YAML 1.2
+---
+title: Schema for design_model model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: design_model
+description: |-
+  Design model name for a telescope.
+data:
+  - type: string
+    default: ""
+instrument:
+  class: Telescope
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: simtools

simtools/schemas/model_parameters/disc_ac_coupled.schema.yml

@@ -0,0 +1,32 @@
+%YAML 1.2
+---
+title: Schema for disc_ac_coupled model parameter
+version: 0.1.0
+meta_schema: simpipe-schema
+meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/model_parameter_and_data_schema.metaschema.yml
+meta_schema_version: 0.1.0
+name: disc_ac_coupled
+description: Discriminators/comparator are AC coupled (if true).
+short_description: Control AC coupling of the discriminators.
+data:
+  - type: boolean
+    default: true
+instrument:
+  class: Camera
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateTriggerPerformance
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray