Merge branch 'dev' into release-v2.5.0

Author: dbirman

docs/source/acquisition.md

@@ -109,7 +109,7 @@ Details about the subject during an acquisition
 | `animal_weight_post` | `Optional[decimal.Decimal]` | Animal weight (g) (Animal weight after procedure) |
 | `weight_unit` | [MassUnit](aind_data_schema_models/units.md#massunit) | Weight unit  |
 | `anaesthesia` | Optional[[Anaesthetic](components/surgery_procedures.md#anaesthetic)] | Anaesthesia (Anaesthesia present during entire acquisition, use Manipulation for partial anaesthesia) |
-| `mouse_platform_name` | `str` | Mouse platform  |
+| `mouse_platform_name` | `str` | Mouse platform (The surface that the mouse is on during the acquisition) |
 | `reward_consumed_total` | `Optional[decimal.Decimal]` | Total reward consumed (mL)  |
 | `reward_consumed_unit` | Optional[[VolumeUnit](aind_data_schema_models/units.md#volumeunit)] | Reward consumed unit  |
 

examples/mri_acquisition.py

@@ -86,7 +86,7 @@
     instrument_id="NA",
     coordinate_system=CoordinateSystemLibrary.MRI_LPS,
     subject_details=AcquisitionSubjectDetails(
-        mouse_platform_name="NA",
+        mouse_platform_name="cradle",
     ),
     data_streams=[stream],
     notes="There was some information about this scan acquisition",

src/aind_data_schema/core/acquisition.py

@@ -83,7 +83,9 @@ class AcquisitionSubjectDetails(DataModel):
         title="Anaesthesia",
         description=("Anaesthesia present during entire acquisition, use Manipulation for partial anaesthesia"),
     )
-    mouse_platform_name: str = Field(..., title="Mouse platform")
+    mouse_platform_name: str = Field(
+        ..., title="Mouse platform", description="The surface that the mouse is on during the acquisition"
+    )
     reward_consumed_total: Optional[Decimal] = Field(default=None, title="Total reward consumed (mL)")
     reward_consumed_unit: Optional[VolumeUnit] = Field(default=None, title="Reward consumed unit")