script as software

Author: saskiad

src/aind_data_schema/device.py

@@ -103,6 +103,7 @@ class Software(AindModel):
 
     name: str = Field(..., title="Software name")
     version: str = Field(..., title="Software version")
+    url: Optional[str] = Field(None, title="URL to commit being used")
     parameters: Optional[dict] = Field(None, title="Software parameters", additionalProperties={"type": "string"})
 
 

src/aind_data_schema/stimulus.py

@@ -98,14 +98,10 @@ class BehaviorStimulation(AindModel):
         title="Behavior software",
         description="The software used to control the behavior (e.g. Bonsai)",
     )
-    behavior_script: str = Field(
+    behavior_script: Software = Field(
         ...,
         title="Behavior script",
-        description="URL for the commit of the code used to run the behavior",
-    )
-    behavior_script_version: str = Field(..., title="Behavior script version")
-    input_parameters: Dict[str, Any] = Field(
-        ..., title="Input parameters", description="Parameters used in behavior session"
+        description="provide URL to the commit of the script and the parameters used",
     )
     output_parameters: Dict[str, Any] = Field(
         ...,

tests/test_behavior.py

@@ -57,12 +57,15 @@ def test_constructors(self):
                         behavior_software=[Software(
                             name="Bonsai",
                             version="0.1"
-                            )
+                            ),
                         ],
                         session_number=3,
-                        behavior_script="URL_to_code",
-                        behavior_script_version="0.1",
-                        input_parameters={"reward volume": 0.01},
+                        behavior_script=Software(
+                            name="Foraging v1",
+                            version="0.1",
+                            url="URL_to_code",
+                            input_parameters={"reward probability": 0.08},
+                        ),
                         output_parameters={},
                         reward_consumed_during_epoch=820,
                         trials_total=551,