SSC ROMAN-3776 Update GDPS data models for G1DP (#701)

gduggan-caltech · pre-commit-ci[bot] · cjarnold · web-flow · commit d11ecfe486c3 · 2025-09-26T09:37:58.000-07:00
* Rename id_catalog with catalog_id to match SOC naming convention of having id appear at the end of the keyname Rename PROGNUM with program to match rad field. Rename PROGRAM_COMPLETE with program_complete to have all keys be lower case. Remove ID_OBS, FILESET_ID, SEGMENT, and VISNUM from observation file, because the catalog is not tied to a specific OBS_ID. Those keys have been moved to g2dp_common for G2DP to provide feedback on. * Update g2dp_common.yaml to include moved fields in required list * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Create 701.misc.rst * Change program_complete from string to boolean * Updated datatypes of segment,visit,observation_id for consistency with these values elsewhere in RAD. Brought in changes to remove the 'meta' nesting * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Chris Arnold <carnold@stsci.edu> Co-authored-by: Paul Huwe <42071634+PaulHuwe@users.noreply.github.com>
diff --git a/changes/701.misc.rst b/changes/701.misc.rst
@@ -0,0 +1 @@
+SSC ROMAN-3776 feedback from SSC GDPS G1DP on the wfi_spec_catalog_level_4.yaml and wfi_spec_data_quality_level_4.yaml data models
diff --git a/latest/SSC/GDPS/keywords/catalog.yaml b/latest/SSC/GDPS/keywords/catalog.yaml
@@ -7,12 +7,12 @@ title: GDPS catalog keywords
 extName: SSC
 type: object
 properties:
-  id_catalog:
+  catalog_id:
     title: Catalog ID
     description: Placeholder.  Example value '0001'
     type: string
     maxLength: 128
     archive_catalog:
       datatype: nvarchar(128)
-      destination: [Placeholder.id_catalog]
-required: [id_catalog]
+      destination: [Placeholder.catalog_id]
+required: [catalog_id]
diff --git a/latest/SSC/GDPS/keywords/g2dp_common.yaml b/latest/SSC/GDPS/keywords/g2dp_common.yaml
@@ -23,4 +23,27 @@ properties:
     archive_catalog:
       datatype: nvarchar(128)
       destination: [Placeholder.id_g2dp_run]
-required: [version_g2dp_software, id_g2dp_run]
+  # NOTE: Including segment and visit will permit better checking that the SSC spectral catalogs match the FILESET_ID it gets associated with
+  segment:
+    title: Segment number
+    description: The sequence of activities produced by each iteration of a Segment Plan (Observation Sequence) in a Pass
+    type: integer
+    archive_catalog:
+      datatype: smallint
+      destination: [Placeholder.segment]
+  visit:
+    title: Visit number
+    description: Visit number within a program
+    type: integer
+    archive_catalog:
+      datatype: smallint
+      destination: [Placeholder.visit]
+  observation_id:
+    title: Programmatic Observation Identifier
+    description: Placeholder.  Example value '0000101001001001001'
+    type: string
+    maxLength: 28
+    archive_catalog:
+      datatype: nvarchar(28)
+      destination: [Placeholder.observation_id]
+required: [version_g2dp_software, id_g2dp_run, segment, visit, observation_id]
diff --git a/latest/SSC/GDPS/keywords/observation.yaml b/latest/SSC/GDPS/keywords/observation.yaml
@@ -7,55 +7,18 @@ title: GDPS observation keywords
 extName: SSC
 type: object
 properties:
-  ID_OBS:
-    title: Observation ID
-    description: Placeholder.  Example value '0000101001001001001'
-    type: string
-    maxLength: 28
-    archive_catalog:
-      datatype: nvarchar(28)
-      destination: [Placeholder.observation_id]
-  # NOTE: fileset_id permits SOC to place the file into the correct SOC fileset
-  # NOTE: SOC uses "fileset" internally and "dataset" exposed to users, hence the mixed use
-  FILESET_ID:
-    title: Dataset ID
-    description: The Level 2 WFI dataset ID, e.g., 'r0017001001001001006_0002_wfi16_f087'
-    type: string
-    maxLength: 28
-    archive_catalog:
-      datatype: nvarchar(28)
-      destination: [Placeholder.fileset_id]
-  PROGNUM:
+  program:
     title: Program number
     description: ID number assigned to the proposal
-    type: string
-    maxLength: 16
+    type: integer
     archive_catalog:
-      datatype: nvarchar(16)
+      datatype: int
       destination: [Placeholder.program]
-  # NOTE: Including SEGMENT and VISNUM will permit better checking that the SSC spectral catalogs match the FILESET_ID it gets associated with
-  SEGMENT:
-    title: Segment number
-    description: The sequence of activities produced by each iteration of a Segment Plan (Observation Sequence) in a Pass
-    type: string
-    maxLength: 16
-    archive_catalog:
-      datatype: nvarchar(16)
-      destination: [CGIExposure.segment, CGIMosaic.segment]
-  VISNUM:
-    title: Visit number
-    description: Visit number within a program
-    type: string
-    maxLength: 16
-    archive_catalog:
-      datatype: nvarchar(16)
-      destination: [CGIExposure.visit, CGIMosaic.visit]
-  PROGRAM_COMPLETE:
+  program_complete:
     title: Program Complete
     description: Placeholder.  Example value 'False'
-    type: string
-    maxLength: 8
+    type: boolean
     archive_catalog:
-      datatype: nvarchar(8)
+      datatype: nchar(1)
       destination: [Placeholder.program_complete]
-required: [ID_OBS, FILESET_ID, PROGNUM, SEGMENT, VISNUM, PROGRAM_COMPLETE]
+required: [program, program_complete]
diff --git a/latest/SSC/GDPS/wfi_spec_catalog_level_4.yaml b/latest/SSC/GDPS/wfi_spec_catalog_level_4.yaml
@@ -9,10 +9,8 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_catalog_level_4-
 title: Level 4 Grism/Prism - Catalog
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/catalog-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/catalog-1.0.0
diff --git a/latest/SSC/GDPS/wfi_spec_combined_1d_level_4.yaml b/latest/SSC/GDPS/wfi_spec_combined_1d_level_4.yaml
@@ -9,13 +9,11 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_combined_1d_leve
 title: Level 4 Grism/Prism - 1D Combined Spectrum for each Source
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
diff --git a/latest/SSC/GDPS/wfi_spec_data_quality_level_4.yaml b/latest/SSC/GDPS/wfi_spec_data_quality_level_4.yaml
@@ -9,10 +9,8 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_data_quality_lev
 title: Level 4 Grism/Prism - Data Quality
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/catalog-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/catalog-1.0.0
diff --git a/latest/SSC/GDPS/wfi_spec_decontaminated_2d_level_4.yaml b/latest/SSC/GDPS/wfi_spec_decontaminated_2d_level_4.yaml
@@ -9,13 +9,11 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_decontaminated_2
 title: Level 4 Grism/Prism - 2D Decontaminated Spectra
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
diff --git a/latest/SSC/GDPS/wfi_spec_individual_1d_level_4.yaml b/latest/SSC/GDPS/wfi_spec_individual_1d_level_4.yaml
@@ -9,13 +9,11 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_individual_1d_le
 title: Level 4 Grism/Prism - 1D Derived Spectrum for each Source
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/calibration-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/wavelength-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/pointing-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/g2dp_common-1.0.0
diff --git a/latest/SSC/GDPS/wfi_spec_location_table_level_4.yaml b/latest/SSC/GDPS/wfi_spec_location_table_level_4.yaml
@@ -9,10 +9,8 @@ id: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/wfi_spec_location_table_l
 title: Level 4 Grism/Prism - Spectra Location Table
 archive_meta: Placeholder SOC file type
 type: object
-properties:
-  meta:
-    allOf:
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
-      - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/location_table-1.0.0
+allOf:
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/ssc_basic-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/observation-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/instrument-1.0.0
+  - $ref: asdf://stsci.edu/datamodels/roman/schemas/SSC/GDPS/keywords/location_table-1.0.0
diff --git a/latest/SSC/ssc_basic.yaml b/latest/SSC/ssc_basic.yaml
@@ -32,7 +32,8 @@ properties:
       The file creation date as taken from the 'fileCreationTimestamp' property of the
       data availability notification (https://github.com/spacetelescope/roman-soc-ssc-common/blob/main/schemas/data_availability.json#L76)
       SSC does not need to include this in the 'metadata' object of the data availability notification.
-    tag: tag:stsci.edu:asdf/time/time-1.*
+    allOf:
+      - $ref: http://stsci.edu/schemas/asdf/time/time-1.3.0#/definitions/iso_time
     archive_catalog:
       datatype: datetime2
       destination:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+SSC ROMAN-3776 feedback from SSC GDPS G1DP on the wfi_spec_catalog_level_4.yaml and wfi_spec_data_quality_level_4.yaml data models`