gammasimtools 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

simtools/schemas/model_parameter_and_data_schema.metaschema.yml

@@ -25,6 +25,7 @@ definitions:
         description: "name of meta schema (e.g. simpipe-schema)"
       meta_schema_url:
         type: string
+        format: uri
         description: "url to meta schema definition"
       meta_schema_version:
         type: string
@@ -246,6 +247,8 @@ definitions:
           - Site
           - Structure
           - Telescope
+          - configuration_sim_telarray
+          - configuration_corsika
       type:
         type: array
         items:
@@ -260,7 +263,6 @@ definitions:
             - South
     required:
       - class
-      - type
     title: Instrument
   InstrumentTypeElement:
     type: string
@@ -322,6 +324,7 @@ definitions:
       - ValidateArrayElementCoordinates
       - ValidateAtmosphericModel
       - ValidateCameraChargeResponse
+      - ValidateCameraEfficiency
       - ValidateCameraGainsAndEfficiency
       - ValidateCameraGeometry
       - ValidateCameraLinearity

simtools/schemas/model_parameters/array_element_position_utm.schema.yml

@@ -7,7 +7,7 @@ meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/si
 meta_schema_version: 0.1.0
 name: array_element_position_utm
 description: |-
-  Position and alitutude of an array element (e.g., a telescope) in UTM coordinates.
+  Position and altitude of an array element (e.g., a telescope) in UTM coordinates.
 short_description: UTM coordinate position of an array element.
 data:
   - type: double

simtools/schemas/model_parameters/array_window.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for array_window 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: array_window
+description: |-
+  Length of a coincidence window of the default stereo trigger,
+  after correction of fixed (cable length, focal length, etc.)
+  and variable (view direction) delays.
+short_description: |-
+  Length of a coincidence window of the default stereo trigger.
+data:
+  - type: double
+    unit: ns
+    default: 1000.
+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

simtools/schemas/model_parameters/asum_clipping.schema.yml

@@ -22,10 +22,6 @@ instrument:
   type:
     - LSTN
     - LSTS
-    - MSTN
-    - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/channels_per_chip.schema.yml

@@ -8,7 +8,7 @@ meta_schema_version: 0.1.0
 name: channels_per_chip
 description: |-
   Number of channels per readout chip.
-  Potentially useful for crosstalk calculations.
+  Potentially useful for cross-talk calculations.
 short_description: Number of channels per readout chip.
 data:
   - type: uint

simtools/schemas/model_parameters/correct_nsb_spectrum_to_telescope_altitude.schema.yml

@@ -16,7 +16,7 @@ data:
     unit: dimensionless
     default: "atm_trans_2200_1_3_0_0_0.dat"
 instrument:
-  class: Telescope
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/corsika_cherenkov_photon_bunch_size.schema.yml

@@ -10,6 +10,8 @@ developer_note: |-
 name: corsika_cherenkov_photon_bunch_size
 description: |-
   Cherenkov bunch size definition.
+instrument:
+  class: configuration_corsika
 data:
   - type: float64
     unit: dimensionless

simtools/schemas/model_parameters/corsika_cherenkov_photon_wavelength_range.schema.yml

@@ -8,6 +8,8 @@ meta_schema_version: 0.1.0
 name: corsika_cherenkov_photon_wavelength_range
 description: |-
   Cherenkov photon wavelength band.
+instrument:
+  class: configuration_corsika
 data:
   - name: wavlgl
     type: float64

simtools/schemas/model_parameters/corsika_first_interaction_height.schema.yml

@@ -10,6 +10,8 @@ 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.
+instrument:
+  class: configuration_corsika
 data:
   - type: float64
     unit: cm

simtools/schemas/model_parameters/corsika_iact_io_buffer.schema.yml

@@ -8,10 +8,12 @@ meta_schema_version: 0.1.0
 name: corsika_iact_io_buffer
 description: |-
   Maximum size of data blocks written by the CORSIKA IACT module.
+instrument:
+  class: configuration_corsika
 data:
   - type: int
-    unit: byte
-    default: 100000000
+    unit: MB
+    default: 1000
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/corsika_iact_max_bunches.schema.yml

@@ -12,6 +12,8 @@ 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).
+instrument:
+  class: configuration_corsika
 data:
   - type: int
     unit: dimensionless

simtools/schemas/model_parameters/corsika_iact_split_auto.schema.yml

@@ -13,6 +13,8 @@ description: |-
   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.
+instrument:
+  class: configuration_corsika
 data:
   - type: int
     unit: dimensionless

simtools/schemas/model_parameters/corsika_longitudinal_shower_development.schema.yml

@@ -9,6 +9,8 @@ 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.
+instrument:
+  class: configuration_corsika
 data:
   - type: float64
     unit: g/cm2

simtools/schemas/model_parameters/corsika_particle_kinetic_energy_cutoff.schema.yml

@@ -8,6 +8,8 @@ meta_schema_version: 0.1.0
 name: corsika_particle_kinetic_energy_cutoff
 description: |-
   Kinetic energy cutoffs for different particle types.
+instrument:
+  class: configuration_corsika
 data:
   - name: hadrons
     type: float64

simtools/schemas/model_parameters/corsika_starting_grammage.schema.yml

@@ -10,6 +10,8 @@ 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.
+instrument:
+  class: configuration_corsika
 data:
   - type: float64
     unit: g/cm2

simtools/schemas/model_parameters/dsum_clipping.schema.yml

@@ -24,8 +24,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_ignore_below.schema.yml

@@ -24,8 +24,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_offset.schema.yml

@@ -23,8 +23,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_pedsub.schema.yml

@@ -20,8 +20,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_pre_clipping.schema.yml

@@ -25,8 +25,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_prescale.schema.yml

@@ -30,8 +30,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_presum_max.schema.yml

@@ -24,8 +24,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_presum_shift.schema.yml

@@ -31,8 +31,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_shaping.schema.yml

@@ -30,8 +30,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_shaping_renormalize.schema.yml

@@ -18,8 +18,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_threshold.schema.yml

@@ -28,8 +28,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/dsum_zero_clip.schema.yml

@@ -28,8 +28,6 @@ instrument:
   type:
     - MSTN
     - MSTS
-    - SSTS
-    - SCTS
 activity:
   setting:
     - SetParameterFromExternal

simtools/schemas/model_parameters/fadc_compensate_pedestal.schema.yml

@@ -8,7 +8,7 @@ meta_schema_version: 0.1.0
 name: fadc_compensate_pedestal
 description: |-
   Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
-  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  to homogenize significant pixel-to-pixel variations of raw pedestals values
   (for high-gain channel for dual-gain readout).
   The resulting values are still unsigned integers and no rescaling takes place
   (pure integer pedestal offset). No compensation takes place for the default value

simtools/schemas/model_parameters/fadc_lg_compensate_pedestal.schema.yml

@@ -8,7 +8,7 @@ meta_schema_version: 0.1.0
 name: fadc_lg_compensate_pedestal
 description: |-
   Emulate FADC pedestal compensation (as e.g., done in camera firmware using FPGAs)
-  to homogenise significant pixel-to-pixel variations of raw pedestals values
+  to homogenize significant pixel-to-pixel variations of raw pedestals values
   (for low-gain channel for dual-gain readout).
   The resulting values are still unsigned integers and no rescaling takes place
   (pure integer pedestal offset). No compensation takes place for the default value

simtools/schemas/model_parameters/fadc_noise.schema.yml

@@ -7,13 +7,13 @@ meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/si
 meta_schema_version: 0.1.0
 name: fadc_noise
 description: |-
-  Gaussian r.m.s. spread of white noise per time bin in digitisation
+  Gaussian r.m.s. spread of white noise per time bin in digitization
   (for high-gain channel, if different gains are used).
-short_description: Gaussian r.m.s. spread of white noise per time bin in digitisation.
+short_description: Gaussian r.m.s. spread of white noise per time bin in digitization.
 data:
   - type: double
     description: |-
-      Gaussian r.m.s. spread of white noise per time bin in digitisation
+      Gaussian r.m.s. spread of white noise per time bin in digitization
       (for high-gain channel in case of dual-readout chain)
     unit: count
     default: 4.0

simtools/schemas/model_parameters/fake_mirror_list.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for fake_mirror_list 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: fake_mirror_list
+short_description: Fake mirror list to be used for camera efficiency calculations ('testeff' program).
+description: |-
+  Fake mirror list to be used for camera efficiency calculations ('testeff' program).
+  Allows to obtain realistic distributions of the photon incidence angles on the camera plan.
+  Not to be used for actual simulations.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Structure
+  type:
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraEfficiency
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/iobuf_maximum.schema.yml

@@ -15,7 +15,7 @@ data:
     allowed_range:
       min: 100000
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/iobuf_output_maximum.schema.yml

@@ -15,7 +15,7 @@ data:
     allowed_range:
       min: 100000
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/laser_photons.schema.yml

@@ -7,9 +7,9 @@ meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/si
 meta_schema_version: 0.1.0
 name: laser_photons
 description: |-
-  Number of laser photons at each photodetector.
+  Number of laser photons at each photo detector.
 short_description: |-
-  Number of laser photons at each photodetector.
+  Number of laser photons at each photo detector.
 data:
   - type: double
     unit: dimensionless

simtools/schemas/model_parameters/lightguide_efficiency_vs_incidence_angle.schema.yml

@@ -3,7 +3,7 @@
 title: Schema for lightguide_efficiency_vs_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/data.metaschema.yml
+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: lightguide_efficiency_vs_incidence_angle
 developer_note: |-

simtools/schemas/model_parameters/lightguide_efficiency_vs_wavelength.schema.yml

@@ -3,7 +3,7 @@
 title: Schema for lightguide_efficiency_vs_wavelength model parameter
 version: 0.1.0
 meta_schema: simpipe-schema
-meta_schema_url: https://raw.githubusercontent.com/gammasim/simtools/main/src/simtools/schemas/data.metaschema.yml
+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: lightguide_efficiency_vs_wavelength
 developer_note: |-

simtools/schemas/model_parameters/min_photoelectrons.schema.yml

@@ -16,7 +16,7 @@ data:
     unit: dimensionless
     default: -1
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/min_photons.schema.yml

@@ -13,7 +13,7 @@ data:
     unit: dimensionless
     default: -1
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/random_generator.schema.yml

@@ -17,7 +17,7 @@ data:
   - type: string
     default: "Ranlux"
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/sampled_output.schema.yml

@@ -12,7 +12,7 @@ data:
   - type: boolean
     default: true
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/save_pe_with_amplitude.schema.yml

@@ -15,7 +15,7 @@ data:
   - type: boolean
     default: false
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/secondary_mirror_degraded_reflection.schema.yml

@@ -10,7 +10,7 @@ description: |-
   Mirror degradation factor for the secondary mirror (wavelength independent).
   Strictly interpreted as being for reflection on the secondary mirror of a
   dual-mirror telescope, and still gets applied in simulations where only
-  the reflection on the primary mirror is bypassd (for example a
+  the reflection on the primary mirror is bypassed (for example a
   flat-fielding light source illuminating the camera via reflection on the
   secondary).
 short_description: |-

simtools/schemas/model_parameters/store_photoelectrons.schema.yml

@@ -22,7 +22,7 @@ data:
       min: 0
       max: 10000
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/model_parameters/tailcut_scale.schema.yml

@@ -19,7 +19,7 @@ data:
       min: 0.0
       max: 10.0
 instrument:
-  class: Camera
+  class: configuration_sim_telarray
   type:
     - LSTN
     - LSTS

simtools/schemas/production_configuration_metrics.schema.yml

@@ -0,0 +1,68 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/ErrorMetrics'
+title: Statistical Error Metrics Schema
+description: |
+  YAML representation of simulation production configuration
+  metrics.
+version: 0.1.0
+name: production_configuration_metrics.metaschema
+type: object
+additionalProperties: false
+
+definitions:
+  ErrorMetrics:
+    type: object
+    description: Definition of error metrics and validity ranges.
+    additionalProperties: false
+    properties:
+      uncertainty_effective_area:
+        $ref: '#/definitions/ErrorMetric'
+      energy_estimate:
+        $ref: '#/definitions/ErrorMetric'
+
+  ErrorMetric:
+    type: object
+    description: Error metric definition.
+    additionalProperties: false
+    properties:
+      description:
+        type: string
+        description: Description of the error metric.
+      target_error:
+        $ref: '#/definitions/TargetError'
+      energy_range:
+        $ref: '#/definitions/EnergyRange'
+    required:
+      - target_error
+      - energy_range
+
+  TargetError:
+    type: object
+    description: Target error specification.
+    additionalProperties: false
+    properties:
+      value:
+        type: number
+        description: Target error value.
+    required:
+      - value
+
+  EnergyRange:
+    type: object
+    description: Energy range specification.
+    additionalProperties: false
+    properties:
+      value:
+        type: array
+        description: Energy range values.
+        items:
+          type: number
+        minItems: 2
+        maxItems: 2
+      unit:
+        type: string
+        description: Energy unit.
+    required:
+      - value
+      - unit

simtools/schemas/production_tables.schema.yml

@@ -0,0 +1,41 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/ProductionModelTable'
+title: SimPipe DB Production Model Metaschema
+description: |
+  YAML representation of DB production model metaschema
+  (based on simulation model DB).
+version: 0.1.0
+name: production_table.metaschema
+type: object
+additionalProperties: false
+
+definitions:
+  ProductionModelTable:
+    properties:
+      model_version:
+        type: string
+        description: Model version.
+        pattern: '^\d+\.\d+\.\d+$'
+      parameters:
+        type: object
+        description: Model parameters.
+        additionalProperties:
+          type: object
+          description: Model parameter.
+          additionalProperties:
+            type: string
+            description: Parameter version (semantical versioning).
+            pattern: '^\d+\.\d+\.\d+$'
+        propertyNames:
+          description: Allowed parameter name patterns.
+          pattern: '^([A-Za-z](ST|LL)[N,S,x]-\d{2,3}|[A-Za-z](ST|LL)[N,S,x]-(design|FlashCam|NectarCam)|OBS-(North|South)|Dummy-Telescope)$'
+      design_model:
+        type: object
+        description: Design models.
+        additionalProperties:
+          type: string
+          description: Design model of a telescope
+    required:
+      - model_version
+      - parameters

simtools/simtel/simtel_config_reader.py

@@ -153,8 +153,7 @@ class SimtelConfigReader:
 
         """
         self._logger.debug(
-            f"Reading simtel config file {simtel_config_file} "
-            f"for parameter {self.parameter_name}"
+            f"Reading simtel config file {simtel_config_file} for parameter {self.parameter_name}"
         )
         matching_lines = {}
         try: