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

simtools/schemas/integration_tests_config.metaschema.yml

@@ -0,0 +1,93 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/SimtoolsIntegrationTestConfiguration'
+title: SimPipe integration test configuration metaschema
+description: YAML representation of integration test configuration metaschema
+version: 0.1.0
+name: integration_tests_config.metaschema
+type: object
+additionalProperties: false
+
+
+definitions:
+  SimtoolsIntegrationTestConfiguration:
+    type: object
+    additionalProperties: false
+    properties:
+      CTA_SIMPIPE:
+        "$ref": "#/definitions/CTASIMPIPE"
+    required:
+      - CTA_SIMPIPE
+    title: ""
+  CTASIMPIPE:
+    type: object
+    additionalProperties: false
+    properties:
+      APPLICATION:
+        type: string
+        description: "Name of simtools application"
+      TEST_NAME:
+        type: string
+        description: "Test name. Should be unique for this application."
+      MODEL_VERSION_USE_CURRENT:
+        type: boolean
+        description: |
+          "Skip test if model version is changed via command line.
+          Important e.g., for cases where DB model is incomplete for some
+          model versions."
+      CONFIGURATION:
+        "$ref": "#/definitions/Configuration"
+      INTEGRATION_TESTS:
+        type: array
+        items:
+          "$ref": "#/definitions/IntegrationTest"
+    required:
+      - APPLICATION
+      - CONFIGURATION
+      - TEST_NAME
+    title: CTASimpipe
+  Configuration:
+    description: "Command line configuration of simtools application."
+    type: object
+    additionalProperties: true
+    title: Configuration
+  IntegrationTest:
+    description: "List of integration tests."
+    type: object
+    additionalProperties: false
+    properties:
+      OUTPUT_FILE:
+        description: |
+          "Path of output file tested to be generated by integration test."
+        type: string
+      FILE_TYPE:
+        description: |
+          "Expected file type of output file generated by integration test."
+        type: string
+      REFERENCE_OUTPUT_FILE:
+        description: |
+          "Reference file used for comparison."
+        type: string
+      EXPECTED_OUTPUT:
+        description: |
+          "Expected output of integration test."
+        type: object
+      TOLERANCE:
+        description: "Allowed tolerance for floating point comparison."
+        type: number
+      TEST_COLUMNS:
+        description: "List of columns to be compared, each with optional cut conditions."
+        type: array
+        items:
+          type: object
+          properties:
+            TEST_COLUMN_NAME:
+              description: "Name of the column to compare."
+              type: string
+            CUT_COLUMN_NAME:
+              description: "Name of the column for applying the cut."
+              type: string
+            CUT_CONDITION:
+              description: "Condition to apply to the cut column."
+              type: string
+    title: IntegrationTest

simtools/schemas/metadata.metaschema.yml

@@ -76,6 +76,12 @@ definitions:
                 format: email
               - type: "null"
             default: null
+          ORCID:
+            description: ORCID identifier of the contact.
+            anyOf:
+              - type: string
+              - type: "null"
+            default: null
       ###############
       PRODUCT:
         title: Product

simtools/schemas/model_parameter.metaschema.yml

@@ -0,0 +1,78 @@
+---
+$schema: http://json-schema.org/draft-06/schema#
+$ref: '#/definitions/SimtoolsModelParameters'
+title: SimPipe DB Model Parameter Metaschema
+description: YAML representation of db model parameter metaschema
+version: 0.1.0
+name: modelparameter.metaschema
+type: object
+additionalProperties: false
+
+
+definitions:
+  SimtoolsModelParameters:
+    description: ""
+    type: object
+    properties:
+      _id:
+        type: string
+        description: "DB unique identifier"
+      applicable:
+        type: boolean
+        description: "Model parameter to be used for this telescope and site"
+      entry_date:
+        type: string
+        description: "Value entry data"
+      file:
+        type: boolean
+        description: "This parameter is a file."
+      instrument:
+        type: string
+        description: "Associated instrument."
+      items:
+        type: string
+        description: "Parameter dimensions."
+      minimum:
+        type: string
+        description: "Minimum allowed value for this parameter (legacy entry)."
+      site:
+        type: string
+        description: "Associated CTAO site."
+        enum:
+          - North
+          - South
+      type:
+        type: string
+        description: "Data type"
+        enum:
+          - boolean
+          - double
+          - int
+          - string
+          - uint
+          - file
+      unit:
+        anyOf:
+          - type: string
+          - type: "null"
+        description: "Unit of the parameter."
+      value:
+        anyOf:
+          - type: boolean
+          - type: number
+          - type: string
+        description: "Value of the parameter."
+      version:
+        anyOf:
+          - type: string
+          - type: "null"
+        description: "Model version."
+    required:
+      - applicable
+      - file
+      - instrument
+      - site
+      - type
+      - unit
+      - value
+      - version

simtools/schemas/{data.metaschema.yml → model_parameter_and_data_schema.metaschema.yml}

@@ -4,7 +4,7 @@ $ref: '#/definitions/SimtoolsDataAndModelParameters'
 title: SimPipe Data and Model Parameter Metaschema
 description: YAML representation of data and model parameter metaschema
 version: 0.1.0
-name: data.metaschema
+name: model_parameter_and_data_schema.metaschema
 type: object
 additionalProperties: false
 
@@ -98,8 +98,13 @@ definitions:
           Use `file` if the parameter describes a file name.
           Use `data_table` if the parameter describes a data table
           (requires TABLE_COLUMNS description)"
-      units:
-        $ref: '#/definitions/Units'
+      json_schema:
+        $ref: "http://json-schema.org/draft-06/schema#"
+        description: |-
+          "json schema describing the parameter"
+        additionalProperties: true
+      unit:
+        $ref: '#/definitions/Unit'
       allowed_range:
         $ref: '#/definitions/ValueRange'
       allowed_values:
@@ -142,14 +147,14 @@ definitions:
           - string
           - boolean
         description: "default value"
-      units:
-        $ref: '#/definitions/Units'
+      unit:
+        $ref: '#/definitions/Unit'
         description: |-
-          "parameter units
+          "parameter unit
           (using astropy names wherever possible)"
     required:
       - type
-      - units
+      - unit
     title: DataClass
   ValueRange:
     type: object
@@ -185,9 +190,9 @@ definitions:
       condition:
         type: string
         description: "condition to change this column to a required data column"
-      units:
+      unit:
         type: string
-        description: "column units"
+        description: "column unit"
       type:
         $ref: '#/definitions/TableColumnType'
         description: "column data type"
@@ -226,7 +231,7 @@ definitions:
       - description
       - name
       - type
-      - units
+      - unit
     title: TableColumn
   Instrument:
     type: object
@@ -236,6 +241,7 @@ definitions:
         type: string
         description: "instrument class"
         enum:
+          - Calibration
           - Camera
           - Site
           - Structure
@@ -261,16 +267,7 @@ definitions:
     description: "specific type of instrument"
     enum:
       - Atmosphere
-      - FlashCam
-      - LSTCam
-      - LSTStructure
-      - MSTStructure
-      - NectarCam
       - Observatory
-      - SCTCam
-      - SCTStructure
-      - SSTCam
-      - SSTStructure
       - None
     title: InstrumentTypeElement
   SimulationSoftware:
@@ -283,10 +280,10 @@ definitions:
         type: string
         description: |-
           "version of simulation software this parameter is used"
-      parameter_name:
+      internal_parameter_name:
         type: string
         description: |-
-          "name of simulation model parameter as used by this software"
+          "Naming of parameter as used this simulation software"
     required:
       - name
     title: SimulationSoftware
@@ -349,36 +346,21 @@ definitions:
     type: string
     enum:
       - boolean
-      - datatable
+      - data_table
+      - dict
       - double
       - float64
       - int
       - string
       - uint
+      - file
     title: TableColumnType
-  Units:
+  Unit:
     type: string
     description: |-
-      "Units correspond to astropy unit names
-      (wherever possible)"
-    enum:
-      - dimensionless
-      - ns
-      - V
-      - mV
-      - deg
-      - m
-      - cm
-      - nm
-      - uT
-      - adc_counts
-      - MHz
-      - GHz
-      - adc_counts / mV
-      - mV * ns
-      - pct
-      - uA
-    title: Units
+      "Unit correspond to astropy unit names"
+    format: astropy_unit
+    title: Unit
   SimulationSoftwareName:
     type: string
     description: |-
@@ -386,7 +368,7 @@ definitions:
     enum:
       - sim_telarray
       - corsika
-      - gammasim-tools
+      - simtools
     title: Name
   Source:
     type: string
@@ -397,4 +379,5 @@ definitions:
       - External
       - Observation execution
       - SimPipe Derived
+      - Configuration
     title: Source

simtools/schemas/model_parameters/adjust_gain.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for adjust_gain 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: adjust_gain
+description: |-
+  Multiplicative adjustment for FADC and discriminator/comparator amplitude
+  and PMT gain.
+short_description: |-
+  Gain adjustment for amplitudes and PMT gain.
+data:
+  - type: double
+    unit: dimensionless
+    default: 1.0
+    allowed_range:
+      min: 0.1
+      max: 10.
+instrument:
+  class: Camera
+  type:
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+  validation:
+    - ValidateParameterByExpert
+    - ValidateCameraGainsAndEfficiency
+source:
+  - Calibration
+simulation_software:
+  - name: sim_telarray

simtools/schemas/model_parameters/altitude.schema.yml

@@ -0,0 +1,37 @@
+%YAML 1.2
+---
+title: Schema for 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: altitude
+description: |-
+  Altitude above sea level of site centre.
+  Telescope z-positions are defined relative to this level
+  (taking `telescope_axes_height` into account).
+short_description: Altitude above sea level of site centre.
+data:
+  - type: double
+    unit: m
+    default: 1800.
+    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

simtools/schemas/model_parameters/array_coordinates.schema.yml

@@ -0,0 +1,33 @@
+%YAML 1.2
+---
+title: Schema for array_coordinates 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: array_coordinates
+description: |-
+  Array element positions (e.g., telescope positions) in ground coordinates.
+data:
+  - type: file
+    unit: dimensionless
+    default: None
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/array_coordinates_UTM.schema.yml

@@ -0,0 +1,77 @@
+%YAML 1.2
+---
+title: Schema for array_coordinates_utm input data
+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_coordinates_utm
+description: |-
+  Array element positions (e.g., telescope positions) in UTM coordinates.
+developer_note: |-
+  Use NaN for missing values.
+data:
+  - type: data_table
+    table_columns:
+      - name: asset_code
+        description: |-
+          Asset code of the array element.
+        type: string
+        required: true
+        unit: dimensionless
+      - name: sequence_number
+        description: |-
+          Sequence number of the array element.
+        type: string
+        required: true
+        unit: dimensionless
+      - name: utm_east
+        description: |-
+          UTM East coordinate of the array element.
+        type: double
+        required: true
+        unit: m
+        input_processing:
+          - allow_nan
+      - name: utm_north
+        description: |-
+          UTM North coordinate of the array element.
+        type: double
+        required: true
+        unit: m
+        input_processing:
+          - allow_nan
+      - name: altitude
+        description: |-
+          Altitude of the array element.
+        required: true
+        type: double
+        unit: m
+        allowed_range:
+          min: 0.
+        input_processing:
+          - allow_nan
+      - name: geo_code
+        description: |-
+          Geographic code of the array element.
+        type: string
+        required: false
+        unit: dimensionless
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: corsika

simtools/schemas/model_parameters/array_element_position_ground.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for array_element_position_ground 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_element_position_ground
+description: |-
+  Position of an array element (e.g., a telescope) in ground coordinates.
+short_description: Ground coordinate position of an array element.
+data:
+  - type: double
+    unit: m
+    description: Array element position in x-direction (towards North)
+  - type: double
+    unit: m
+    description: Array element position in y-direction (towards West)
+  - type: double
+    unit: m
+    description: Array element altitude above reference_point_altitude
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup

simtools/schemas/model_parameters/array_element_position_utm.schema.yml

@@ -0,0 +1,39 @@
+%YAML 1.2
+---
+title: Schema for array_element_position_utm 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_element_position_utm
+description: |-
+  Position and alitutude of an array element (e.g., a telescope) in UTM coordinates.
+short_description: UTM coordinate position of an array element.
+data:
+  - type: double
+    unit: m
+    description: Array element position in UTM East.
+  - type: double
+    unit: m
+    description: Array element position in UTM North.
+  - type: double
+    unit: m
+    description: Array element altitude above sea level.
+instrument:
+  class: Structure
+  type:
+    - LSTN
+    - LSTS
+    - MSTN
+    - MSTS
+    - SSTS
+    - SCTS
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup

simtools/schemas/model_parameters/array_layouts.schema.yml

@@ -0,0 +1,48 @@
+%YAML 1.2
+---
+title: Schema for array_layouts 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_layouts
+description: |-
+  Array layout definitions.
+data:
+  - type: dict
+    json_schema:
+      type: array
+      items:
+        type: object
+        properties:
+          name:
+            type: string
+            description: Name of the array layout.
+          elements:
+            type: array
+            items:
+              type: string
+              format: array_element
+              description: Name of the array element.
+        required:
+          - name
+          - elements
+        additionalProperties: false
+instrument:
+  class: Site
+  type:
+    - Observatory
+  site:
+    - North
+    - South
+activity:
+  setting:
+    - SetParameterFromExternal
+    - SetArrayElementCoordinates
+  validation:
+    - ValidateParameterByExpert
+    - ValidateArrayElementCoordinates
+source:
+  - Initial instrument setup
+simulation_software:
+  - name: simtools