add experiment_id as required field in Experiment

Author: clevinson

.gitignore

@@ -137,3 +137,5 @@ dmypy.json
 # Claude AI instruction set
 CLAUDE.md
 .beads/
+
+examples/

project/jsonschema/oae_data_protocol.schema.json

@@ -1398,6 +1398,11 @@
                     "title": "End Date and Time",
                     "type": "string"
                 },
+                "experiment_id": {
+                    "description": "The experiment to which the data belong. Any naming convention that produces a unique ID is usable. The recommended naming convention is:\nProject ID + Experiment type + Optional numerical indicator to differentiate between various experiments of the same type for a project. A two digit consecutive number beginning with 01",
+                    "title": "Experiment ID",
+                    "type": "string"
+                },
                 "experiment_type": {
                     "$ref": "#/$defs/ExperimentType",
                     "description": "The type of mCDR experiment conducted. See Controlled Vocabularies section for definitions.",
@@ -1458,6 +1463,7 @@
             "required": [
                 "description",
                 "spatial_coverage",
+                "experiment_id",
                 "experiment_type",
                 "investigators",
                 "start_datetime",
@@ -1941,6 +1947,11 @@
                     "description": "Whether the feedstock was pre-equilibrated or unequilibrated",
                     "title": "Equilibration"
                 },
+                "experiment_id": {
+                    "description": "The experiment to which the data belong. Any naming convention that produces a unique ID is usable. The recommended naming convention is:\nProject ID + Experiment type + Optional numerical indicator to differentiate between various experiments of the same type for a project. A two digit consecutive number beginning with 01",
+                    "title": "Experiment ID",
+                    "type": "string"
+                },
                 "experiment_type": {
                     "$ref": "#/$defs/ExperimentType",
                     "description": "The type of mCDR experiment conducted. See Controlled Vocabularies section for definitions.",
@@ -2014,6 +2025,7 @@
                 "dosing_description",
                 "description",
                 "spatial_coverage",
+                "experiment_id",
                 "experiment_type",
                 "investigators",
                 "start_datetime",
@@ -2164,6 +2176,11 @@
                     "description": "Whether the feedstock was pre-equilibrated or unequilibrated",
                     "title": "Equilibration"
                 },
+                "experiment_id": {
+                    "description": "The experiment to which the data belong. Any naming convention that produces a unique ID is usable. The recommended naming convention is:\nProject ID + Experiment type + Optional numerical indicator to differentiate between various experiments of the same type for a project. A two digit consecutive number beginning with 01",
+                    "title": "Experiment ID",
+                    "type": "string"
+                },
                 "experiment_type": {
                     "$ref": "#/$defs/ExperimentType",
                     "description": "The type of mCDR experiment conducted. See Controlled Vocabularies section for definitions.",
@@ -2255,6 +2272,7 @@
                 "dosing_description",
                 "description",
                 "spatial_coverage",
+                "experiment_id",
                 "experiment_type",
                 "investigators",
                 "start_datetime",
@@ -3701,6 +3719,11 @@
                     "title": "End Date and Time",
                     "type": "string"
                 },
+                "experiment_id": {
+                    "description": "The experiment to which the data belong. Any naming convention that produces a unique ID is usable. The recommended naming convention is:\nProject ID + Experiment type + Optional numerical indicator to differentiate between various experiments of the same type for a project. A two digit consecutive number beginning with 01",
+                    "title": "Experiment ID",
+                    "type": "string"
+                },
                 "experiment_type": {
                     "$ref": "#/$defs/ExperimentType",
                     "description": "The type of mCDR experiment conducted. See Controlled Vocabularies section for definitions.",
@@ -3785,6 +3808,7 @@
                 "dosing_description",
                 "description",
                 "spatial_coverage",
+                "experiment_id",
                 "experiment_type",
                 "investigators",
                 "start_datetime",

src/oae_data_protocol/datamodel/oae_data_protocol.py

@@ -1,5 +1,5 @@
 # Auto generated from oae_data_protocol.yaml by pythongen.py version: 0.0.1
-# Generation date: 2026-01-27T19:02:48
+# Generation date: 2026-01-27T19:47:22
 # Schema: OAEDataManagementProtocol
 #
 # id: OAEDataManagementProtocol
@@ -561,11 +561,11 @@ class Experiment(YAMLRoot):
 
     description: str = None
     spatial_coverage: Union[dict, SpatialCoverage] = None
+    experiment_id: str = None
     experiment_type: Union[str, "ExperimentType"] = None
     investigators: Union[Union[dict, "Person"], List[Union[dict, "Person"]]] = None
     start_datetime: Union[str, XSDDateTime] = None
     end_datetime: Union[str, XSDDateTime] = None
-    experiment_id: str = None
     name: Optional[str] = None
     vertical_coverage: Optional[Union[dict, VerticalExtent]] = None
     permits: Optional[Union[Union[dict, Permit], List[Union[dict, Permit]]]] = empty_list()
@@ -584,6 +584,11 @@ def __post_init__(self, *_: List[str], **kwargs: Dict[str, Any]):
         if not isinstance(self.spatial_coverage, SpatialCoverage):
             self.spatial_coverage = SpatialCoverage(**as_dict(self.spatial_coverage))
 
+        if self._is_empty(self.experiment_id):
+            self.MissingRequiredField("experiment_id")
+        if not isinstance(self.experiment_id, str):
+            self.experiment_id = str(self.experiment_id)
+
         if self._is_empty(self.experiment_type):
             self.MissingRequiredField("experiment_type")
         if not isinstance(self.experiment_type, ExperimentType):
@@ -605,11 +610,6 @@ def __post_init__(self, *_: List[str], **kwargs: Dict[str, Any]):
         if not isinstance(self.end_datetime, XSDDateTime):
             self.end_datetime = XSDDateTime(self.end_datetime)
 
-        if self._is_empty(self.experiment_id):
-            self.MissingRequiredField("experiment_id")
-        if not isinstance(self.experiment_id, str):
-            self.experiment_id = str(self.experiment_id)
-
         if self.name is not None and not isinstance(self.name, str):
             self.name = str(self.name)
 
@@ -648,11 +648,11 @@ class Intervention(Experiment):
 
     description: str = None
     spatial_coverage: Union[dict, SpatialCoverage] = None
+    experiment_id: str = None
     experiment_type: Union[str, "ExperimentType"] = None
     investigators: Union[Union[dict, "Person"], List[Union[dict, "Person"]]] = None
     start_datetime: Union[str, XSDDateTime] = None
     end_datetime: Union[str, XSDDateTime] = None
-    experiment_id: str = None
     alkalinity_feedstock_processing: Union[str, "AlkalinityFeedstockProcessing"] = None
     alkalinity_feedstock_form: Union[str, "AlkalinityFeedstockForm"] = None
     alkalinity_feedstock: Union[str, "FeedstockType"] = None
@@ -758,11 +758,11 @@ class Tracer(Experiment):
 
     description: str = None
     spatial_coverage: Union[dict, SpatialCoverage] = None
+    experiment_id: str = None
     experiment_type: Union[str, "ExperimentType"] = None
     investigators: Union[Union[dict, "Person"], List[Union[dict, "Person"]]] = None
     start_datetime: Union[str, XSDDateTime] = None
     end_datetime: Union[str, XSDDateTime] = None
-    experiment_id: str = None
     tracer_form: Union[str, "TracerForm"] = None
     tracer_details: str = None
     tracer_concentration: Union[dict, "DosingConcentration"] = None
@@ -837,11 +837,11 @@ class InterventionWithTracer(Intervention):
 
     description: str = None
     spatial_coverage: Union[dict, SpatialCoverage] = None
+    experiment_id: str = None
     experiment_type: Union[str, "ExperimentType"] = None
     investigators: Union[Union[dict, "Person"], List[Union[dict, "Person"]]] = None
     start_datetime: Union[str, XSDDateTime] = None
     end_datetime: Union[str, XSDDateTime] = None
-    experiment_id: str = None
     alkalinity_feedstock_processing: Union[str, "AlkalinityFeedstockProcessing"] = None
     alkalinity_feedstock_form: Union[str, "AlkalinityFeedstockForm"] = None
     alkalinity_feedstock: Union[str, "FeedstockType"] = None

src/oae_data_protocol/schema/experiment.yaml

@@ -17,6 +17,7 @@ classes:
       - spatial_coverage
       - vertical_coverage
       - permits
+      - experiment_id
     slot_usage:
       experiment_id:
         required: true